WENior commited on
Commit
7e00c0d
Β·
verified Β·
1 Parent(s): 208e04e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +65 -12
README.md CHANGED
@@ -1,12 +1,65 @@
1
- # Paper Reader Assistant (Gradio on Hugging Face Spaces)
2
-
3
- Features:
4
- - Upload PDFs β†’ extract text (PyMuPDF)
5
- - Summarization (BART map-reduce)
6
- - Keyword extraction (KeyBERT)
7
- - RAG QA with FAISS + sentence-transformers + Flan-T5
8
-
9
- Quick Start:
10
- 1. Create a new **Space** with SDK = **Gradio**.
11
- 2. Upload three files: `app.py`, `requirements.txt`, `README.md`.
12
- 3. Wait for auto-build to finish. Open the Space URL.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Paper Reader Assistant
3
+ emoji: πŸ“š
4
+ colorFrom: blue
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: "4.44.0"
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ # πŸ“– Paper Reader Assistant (Gradio on Hugging Face Spaces)
13
+
14
+ This Space helps you **read and analyze academic papers** with AI assistance.
15
+ You can upload PDF files, and the app will automatically extract text, generate summaries, identify keywords, and enable question answering using RAG (Retrieval-Augmented Generation).
16
+
17
+ ---
18
+
19
+ ## πŸš€ Features
20
+
21
+ - 🧾 **PDF Upload** β†’ Extracts text using PyMuPDF
22
+ - ✍️ **Summarization** β†’ Uses BART for map-reduce summarization
23
+ - πŸ”‘ **Keyword Extraction** β†’ Powered by KeyBERT
24
+ - ❓ **Q&A (RAG)** β†’ Combines FAISS + SentenceTransformers + Flan-T5
25
+ - 🧠 **All-in-one academic reading assistant**
26
+
27
+ ---
28
+
29
+ ## βš™οΈ Quick Start
30
+
31
+ 1. Create a new **Space** on Hugging Face with SDK = **Gradio**
32
+ 2. Upload three files:
33
+ - `app.py`
34
+ - `requirements.txt`
35
+ - `README.md` (this file)
36
+ 3. Save changes β€” Spaces will automatically build and launch the app
37
+ 4. Once it’s live, open the Space URL to start using it
38
+
39
+ ---
40
+
41
+ ## πŸ’‘ Notes
42
+
43
+ - Works best on **English scientific PDFs** (text-based).
44
+ - For **scanned PDFs**, run OCR first (not yet included in this version).
45
+ - Models run on **CPU by default** β€” enable GPU for faster processing.
46
+ - You can further customize UI theme, font color, or add dark mode by editing `app.py`.
47
+
48
+ ---
49
+
50
+ ## 🧰 Tech Stack
51
+
52
+ | Component | Description |
53
+ |------------|-------------|
54
+ | **Gradio** | Front-end interface |
55
+ | **PyMuPDF** | PDF text extraction |
56
+ | **Transformers (BART)** | Summarization |
57
+ | **KeyBERT** | Keyword extraction |
58
+ | **Sentence-Transformers + FAISS** | Vector retrieval for Q&A |
59
+ | **Flan-T5** | Natural language generation |
60
+
61
+ ---
62
+
63
+ **Author:** WENIor
64
+ **License:** MIT
65
+ **Version:** 1.0.0