MoJaff commited on
Commit
562ceb9
·
verified ·
1 Parent(s): 6615736

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +29 -1
README.md CHANGED
@@ -9,5 +9,33 @@ app_file: app.py
9
  pinned: false
10
  license: apache-2.0
11
  ---
 
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  pinned: false
10
  license: apache-2.0
11
  ---
12
+ # Article Summarization App
13
 
14
+ This is a simple web application built with Gradio and Hugging Face's Transformers library that allows users to summarize articles using the `facebook/bart-large-cnn` model. The app provides an easy-to-use interface where users can input an article, set the minimum and maximum length for the summary, and get a concise summary in return.
15
+
16
+ ## How It Works
17
+
18
+ The app uses the `facebook/bart-large-cnn` model from Hugging Face's Transformers library to generate summaries. Users can input an article, adjust the desired length of the summary using sliders, and the app will generate a summary based on the provided input.
19
+
20
+ ## Features
21
+
22
+ - **Input Article**: Users can paste or type an article into the text box.
23
+ - **Adjustable Summary Length**: Users can set the minimum and maximum length of the summary using sliders.
24
+ - **Example Provided**: An example article is provided to demonstrate how the app works.
25
+ - **Real-Time Summarization**: The app generates the summary in real-time as soon as the user inputs the article and adjusts the sliders.
26
+
27
+ ## How to Use
28
+
29
+ 1. **Enter an Article**: Paste or type the article you want to summarize into the text box labeled "Enter an article to summarize."
30
+ 2. **Set Summary Length**: Use the sliders to set the minimum and maximum length of the summary.
31
+ - **Min Length**: The minimum number of words in the summary.
32
+ - **Max Length**: The maximum number of words in the summary.
33
+ 3. **Get the Summary**: The app will automatically generate a summary based on your input and display it in the output text box.
34
+
35
+ ## Example
36
+
37
+ An example article is provided in the app to help you get started. Simply click on the example, and the app will automatically fill in the article and generate a summary.
38
+
39
+ ## Contact
40
+
41
+ If you have any questions or suggestions, feel free to reach out to me on [LinkedIn](https://www.linkedin.com/in/mohammad-alkhatim-9b1770266/).