Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
@@ -10,4 +10,59 @@ pinned: false
|
|
10 |
license: apache-2.0
|
11 |
---
|
12 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
13 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
10 |
license: apache-2.0
|
11 |
---
|
12 |
|
13 |
+
# Text Summarization App
|
14 |
+
|
15 |
+
This is a simple app that uses the `facebook/bart-large-cnn` model from Hugging Face to summarize long-form text. The app takes an article, paper, or book, and summarizes it into key points or a concise paragraph.
|
16 |
+
|
17 |
+
## Features
|
18 |
+
|
19 |
+
- Summarizes long text into a short, readable summary.
|
20 |
+
- Works on various kinds of text (articles, papers, books).
|
21 |
+
- Uses Hugging Face's BART model for high-quality summaries.
|
22 |
+
- Provides a simple and user-friendly interface built with Gradio.
|
23 |
+
|
24 |
+
## How It Works
|
25 |
+
|
26 |
+
1. The user inputs a long-form text (article, paper, or book) in the provided input box.
|
27 |
+
2. The app processes the input using the `facebook/bart-large-cnn` model.
|
28 |
+
3. A summarized version of the text is displayed as output.
|
29 |
+
|
30 |
+
## Setup and Installation
|
31 |
+
|
32 |
+
1. Clone the repository:
|
33 |
+
```bash
|
34 |
+
git clone https://huggingface.co/spaces/your-username/Text-Summarization-App
|
35 |
+
cd Text-Summarization-App
|
36 |
+
```
|
37 |
+
|
38 |
+
2. Install the dependencies from `requirements.txt`:
|
39 |
+
```bash
|
40 |
+
pip install -r requirements.txt
|
41 |
+
```
|
42 |
+
|
43 |
+
3. Run the app locally:
|
44 |
+
```bash
|
45 |
+
python app.py
|
46 |
+
```
|
47 |
+
|
48 |
+
4. To deploy on Hugging Face Spaces, just upload your code and the necessary files to the Hugging Face Space and it will be ready to use.
|
49 |
+
|
50 |
+
## Technologies Used
|
51 |
+
|
52 |
+
- **Gradio**: For the user interface.
|
53 |
+
- **Hugging Face Transformers**: For using the pre-trained BART model for summarization.
|
54 |
+
- **PyTorch**: Deep learning framework used for running the BART model.
|
55 |
+
|
56 |
+
## Example
|
57 |
+
|
58 |
+
Input: "Long article text here..."
|
59 |
+
|
60 |
+
Output: "Concise summary of the article here..."
|
61 |
+
|
62 |
+
## License
|
63 |
+
|
64 |
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
65 |
+
|
66 |
+
|
67 |
+
|
68 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|