luthrabhuvan commited on
Commit
899cae4
·
verified ·
1 Parent(s): e6fd985

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +62 -8
README.md CHANGED
@@ -1,14 +1,68 @@
1
- # Book Recommender (Flask Version)
 
 
 
 
 
 
 
 
 
2
 
3
- This project implements a content-based book recommendation system using Python, Flask, and scikit-learn. It allows users to upload a CSV or Excel file containing book titles and summaries, and then enter a book title to receive recommendations for similar books.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
 
5
  ## Dependencies
6
 
7
- - Flask: Used for creating the web application.
8
- - pandas: Used for data loading and manipulation.
9
- - scikit-learn: Used for TF-IDF vectorization and cosine similarity calculation.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
 
11
- You can install these dependencies using pip:
 
 
12
 
13
- ```bash
14
- pip install Flask pandas scikit-learn
 
1
+ ---
2
+ title: Book Recommender
3
+ emoji: 📚
4
+ colorFrom: indigo
5
+ colorTo: blue
6
+ sdk: docker
7
+ sdk_version: "latest" # Or specify a version if needed
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
 
12
+ # Book Recommender (Flask)
13
+
14
+ This Hugging Face Space hosts a web application for recommending books based on their summaries. It's built using Python, Flask, pandas, and scikit-learn.
15
+
16
+ ## How to Use
17
+
18
+ 1. **Upload Data:** Upload a CSV or Excel file containing book titles and summaries. The file *must* have columns named "title" and "summary" (case-sensitive).
19
+ 2. **Process Data:** Click the "Upload and Process" button.
20
+ 3. **Get Recommendations:** Enter a book title and click the "Get Recommendations" button. The app will display similar books.
21
+
22
+ ## Data Format
23
+
24
+ The uploaded CSV or Excel file should have the following columns:
25
+
26
+ * `title` (string): The title of the book.
27
+ * `summary` (string): A brief summary of the book.
28
 
29
  ## Dependencies
30
 
31
+ The following Python libraries are used:
32
+
33
+ * Flask
34
+ * pandas
35
+ * scikit-learn
36
+ * gunicorn
37
+
38
+ These dependencies are listed in the `requirements.txt` file.
39
+
40
+ ## Running Locally (for development)
41
+
42
+ 1. Clone the repository:
43
+
44
+ ```bash
45
+ git clone <repository_url>
46
+ ```
47
+
48
+ 2. Create a virtual environment:
49
+
50
+ ```bash
51
+ python3 -m venv venv
52
+ source venv/bin/activate # macOS/Linux
53
+ venv\Scripts\activate # Windows
54
+ ```
55
+
56
+ 3. Install dependencies:
57
+
58
+ ```bash
59
+ pip install -r requirements.txt
60
+ ```
61
+
62
+ 4. Run the app:
63
 
64
+ ```bash
65
+ python app.py
66
+ ```
67
 
68
+ ## File Structure