AAI-Assessment3 / README.md
mrsk1883's picture
Update README.md
712d966
---
title: AAI Assessment3
emoji: 😻
colorFrom: pink
colorTo: purple
sdk: gradio
sdk_version: 4.8.0
app_file: app.py
pinned: false
license: mit
---
# PDF Summarization & Audio Tool
## Description
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.
## How to Use
1. **Upload PDF:** Click on the "Upload PDF" button to upload a PDF file. Ensure that the PDF contains an abstract or introduction section.
2. **View Summary:** The app will display a one-sentence summary of the abstract.
3. **Listen to Summary:** Click on the "Listen" button to hear an audio summary of the abstract.
## Examples
To test the app, you can use the provided example PDF's in the `examples` directory. Follow these steps:
1. Upload one of the example PDFs.
2. Check the generated summary and listen to the audio.
### Example PDFs
- [Example 1](https://drive.google.com/file/d/159MEhJuP4UpSCTYTn2ACLqNfAhLVVePx/view?usp=sharing)
- [Example 2](https://drive.google.com/file/d/1_q7mf2PDVTGRKCDvmcvoBHsV6z1-5Tv2/view?usp=sharing)
## Notes
- Ensure that the uploaded PDF contains an abstract or introduction section for accurate results.
- For the best experience, use the provided examples first to understand how the app works.
## Development
To run the app locally:
```bash
pip install -r requirements.txt
python app.py
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference