Spaces:
Runtime error
Runtime error
Update README.md
Browse files
README.md
CHANGED
@@ -9,5 +9,44 @@ app_file: app.py
|
|
9 |
pinned: false
|
10 |
license: mit
|
11 |
---
|
|
|
12 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
13 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
9 |
pinned: false
|
10 |
license: mit
|
11 |
---
|
12 |
+
# PDF Summarization & Audio Tool
|
13 |
|
14 |
+
## Description
|
15 |
+
|
16 |
+
This Gradio app summarizes the abstract of a PDF in one sentence and generates an audio file. It uses the "pszemraj/led-large-book-summary" model to generate summaries.
|
17 |
+
|
18 |
+
## How to Use
|
19 |
+
|
20 |
+
1. **Upload PDF:** Click on the "Upload PDF" button to upload a PDF file. Ensure that the PDF contains an abstract or introduction section.
|
21 |
+
|
22 |
+
2. **View Summary:** The app will display a one-sentence summary of the abstract.
|
23 |
+
|
24 |
+
3. **Listen to Summary:** Click on the "Listen" button to hear an audio summary of the abstract.
|
25 |
+
|
26 |
+
## Examples
|
27 |
+
|
28 |
+
To test the app, you can use the provided example PDF's in the `examples` directory. Follow these steps:
|
29 |
+
|
30 |
+
1. Upload one of the example PDFs.
|
31 |
+
2. Check the generated summary and listen to the audio.
|
32 |
+
|
33 |
+
### Example PDFs
|
34 |
+
|
35 |
+
- [Example 1](https://drive.google.com/file/d/159MEhJuP4UpSCTYTn2ACLqNfAhLVVePx/view?usp=sharing)
|
36 |
+
- [Example 2](https://drive.google.com/file/d/1_q7mf2PDVTGRKCDvmcvoBHsV6z1-5Tv2/view?usp=sharing)
|
37 |
+
|
38 |
+
## Notes
|
39 |
+
|
40 |
+
- Ensure that the uploaded PDF contains an abstract or introduction section for accurate results.
|
41 |
+
- For the best experience, use the provided examples first to understand how the app works.
|
42 |
+
|
43 |
+
## Development
|
44 |
+
|
45 |
+
To run the app locally:
|
46 |
+
|
47 |
+
```bash
|
48 |
+
pip install -r requirements.txt
|
49 |
+
python app.py
|
50 |
+
|
51 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
52 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|