# Kitabe
**Repository Path**: personalDemo/Kitabe
## Basic Information
- **Project Name**: Kitabe
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-05
- **Last Updated**: 2024-04-05
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
**Kitabe** (*Book in Hindi*) is a Book Recommendation System built for all you Book Lovers๐.
Simply Rate โญ some books and get immediate recommendations tailored for you ๐คฉ.
See [Demo](#user-content-demo-) ๐ฅ
[](https://kitabe.up.railway.app/)
[](https://travis-ci.com/Praful932/Kitabe)
[](https://github.com/Praful932/Kitabe/blob/master/CONTRIBUTING.md)
[](LICENSE)
[](https://hits.seeyoufarm.com)
[](https://GitHub.com/Praful932/Kitabe/graphs/commit-activity)
  
For Contributing ๐ and setting Up head [here](https://github.com/Praful932/Kitabe/blob/master/CONTRIBUTING.md).
# Contents
- [Demo](#user-content-demo-) ๐ฅ
- [Approach](#objective-) ๐ง
- [Objective](#objective-) โ
- [Dataset](#dataset-) ๐งพ
- [PreProcessing](#preprocessing-) ๐
- [Model Exploration](#model-exploration-) ๐คฏ
- [Final Result](#final-result-) ๐
- [Project Structure](#project-structure-%EF%B8%8F) ๐โโ๏ธ
- [To Do](#to-do-) ๐ฏ
- [Contribute](https://github.com/Praful932/Kitabe/blob/master/CONTRIBUTING.md) ๐งโโ๏ธ
- [Notebooks and Files](#notebooks-and-files-) ๐
- [References](#references-) ๐
- [Contributors](#contributors-) ๐ค
- [License](#license-) โ
### Demo ๐ฅ
[Live Application](https://kitabe.up.railway.app/) ๐
### Objective โ
Our objective is to build an application for all Book Lovers โฅ like us out there where all you have to
do is rate some of your favorite books and the application will do it's **voodoo magic** ๐งโโ๏ธ and give you some more books that you may **love๐ to read**.
### Dataset ๐งพ
The Dataset that we used for this task is the [goodbooks-10k](https://github.com/zygmuntz/goodbooks-10k) dataset. It consists of 10k books with a total of 6 million ratings. That's huge right! ๐ฎ. There are some more huge datasets such as [Book-Crossings](http://www2.informatik.uni-freiburg.de/~cziegler/BX/) but they are kinda old ๐ฌ.
**Dataset Structure**
```
GoodBooks10k
โโโ books.csv # Contains book info with book-id
โโโ ratings.csv # Maps user-id to book-id and rating
โโโ book_tags.csv # Contains tag-id associated with book-ids
โโโ tags.csv # Contains tag-name associated with tag-id
โโโ to_read.csv # Contains book-ids marked as to-read by user
```
### PreProcessing ๐
Since this is a recommendation problem, we have to make sure that the `books.csv` is as clean as possible and only consider those ratings whose book-id is present, same goes for vice versa.
More Cleaning for `books.csv`
- Missing Book Image URLs
- Book & Rating Duplicates
### Model Exploration ๐คฏ
For Recommendation Problems there are multiple approaches that are possible:
- Embedding Matrix
- Singular Matrix Decomposition
- Term Frequency
We experimented with several methods and chose Embedding Matrix & Term Frequency.
- **Embedding Matrix** - This method is often called [FunkSVD](https://www.coursera.org/lecture/matrix-factorization/deriving-funksvd-lyTpD) which won the Netflix Prize back in 2004. Since it is a gradient based function minimization approach we like to call it as Embedding Matrix. Calling it SVD [confuses](https://www.quora.com/What-is-the-difference-between-SVD-and-matrix-factorization-in-context-of-recommendation-engine/answer/Luis-Argerich) it with the one in Linear Algebra. This Embedding Matrix constructs a vector for each user and each book, such that when the product is applied with additional constraints it gives us the rating. For more elaborate info on FunkSVD refer [this](http://sifter.org/~simon/journal/20061211.html).
We used the book embedding as a representation of the books to infer underlying patterns. This led to the embedding able to detect books from the same authors and also infer genres such as Fiction, Autobiography and more.
- **Term Frequency** - This method is like a helper function to above, it shines where embedding fails. Term Frequency takes into account the tokens in a book title be it the book title itself, the name of authors and also rating. Taking into consideration it finds books which match closely with the tokens in the rated book.
> ๐ Code for every step can be found in the [Notebooks and Files](#notebooks-and-files) Section.
### Final Result ๐
The [Image](https://coggle.it/diagram/X6TOUxlMvSl8FBM4/t/dataset/7083ac4f2de39517a4d97cd9d3d211c11af6e65f9a0034c46d613ff0f9cd5) says it All.
### Project Structure ๐โโ๏ธ
```
Kitabe
โ
โโโโBookRecSystem # Main Project Directory
โ
โโโโmainapp # Project Main App Directory
โ โ
โ โโโโmigrations # Migrations
โ
โโโโstatic
| | # Static Directory
โ โโโโmainapp
โ โโโโcss # CSS Files
| |
โ โโโโdataset # Dataset Files
โ โ
โ โโโโgif # GIF Media
โ โ
โ โโโโmodel_files # Model Files
| | |
โ โ โโโโsurprise # FunkSVD Files
โ โ โ
โ โ โโโโcv # CV Files
โ โ
โ โโโโpng # PNG Media FIles
|
โโโโtemplates # Root Template DIrectory
|
โโโโaccount # Account App Templates
โ
โโโโmainapp # Project Main App Templates
```
### To Do ๐ฏ
- [X] Display Popular Books Among Users
- [X] Add AJAX View Tests
- [X] Add Model Tests
- [X] Use a Better Approach than Count Vectorizer
### Notebooks and Files ๐
- [All Dataset & Model Files](https://drive.google.com/drive/folders/1SvuCvfiSxwuF21EvmKyhSkuwjgK7KU6S?usp=sharing)
- [Cleaning and Embedding Notebook](https://drive.google.com/file/d/1wlKiSvYQEXG7xtru5jDQWQwxffaVd9Ap/view?usp=sharing)
- [Fix Missing Images Notebook](https://drive.google.com/file/d/1S0pd5t9oU9a63EdmlXmxhNWGc228W3ke/view?usp=sharing)
- [Genre Wise & Tfidf Vectorizer Notebook](https://drive.google.com/file/d/1LRr4Nm2I2HRJUTXbRea3sK5A1Bvp_lav/view?usp=sharing)
### References ๐
- [Dataset](https://github.com/zygmuntz/goodbooks-10k)
- [Count Vectorizer](https://www.kaggle.com/sasha18/recommend-books-using-count-tfidf-on-titles)
- [Books2Rec](https://github.com/dorukkilitcioglu/books2rec)
### Contributors ๐ค
### License โ
```
MIT License
Copyright (c) 2020 Praful Mohanan & Prajakta Mane
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```