ghostai1 commited on
Commit
6e1bee9
·
verified ·
1 Parent(s): afe9c02

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +48 -1
README.md CHANGED
@@ -10,5 +10,52 @@ pinned: false
10
  license: apache-2.0
11
  short_description: CPU-only Text Summarization
12
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
10
  license: apache-2.0
11
  short_description: CPU-only Text Summarization
12
  ---
13
+ # 📝 Text Summarization Demo
14
+ [![Hugging Face Space](https://img.shields.io/badge/HuggingFace-Spaces-blue?logo=huggingface)](https://huggingface.co/spaces/your-username/text-summarizer)
15
+ [![Gradio UI](https://img.shields.io/badge/Gradio-5.31.0-brightgreen?logo=gradio)]
16
+ [![Model](https://img.shields.io/badge/Model-DistilBART--CNN-orange)](https://huggingface.co/sshleifer/distilbart-cnn-12-6)
17
+ [![License](https://img.shields.io/badge/License-MIT-lightgrey)](LICENSE)
18
+
19
+ ---
20
+
21
+ ## 🚀 Overview
22
+ Leverage **Transformer-based NLP** to condense long text into a crisp summary.
23
+ Ideal for articles, reports, or meeting notes—runs entirely on **free CPU**.
24
+
25
+ > **Key AI buzzwords:**
26
+ > • Distilled BART • Abstractive Summarization • Sequence-to-Sequence • Real-time inference • Edge deployment • Cloud-native demo
27
+
28
+ ---
29
+
30
+ ## ✨ Features
31
+
32
+ | 🔑 Feature | 🔍 Description |
33
+ |--------------------------|------------------------------------------------------------------|
34
+ | **🧠 Distilled BART** | Uses `sshleifer/distilbart-cnn-12-6` for fast, accurate summaries |
35
+ | **⚡ CPU-Only Inference** | <500 ms per 500 words on a free-tier Space CPU |
36
+ | **🎛️ Adjustable Length** | Control summary brevity with max/min token sliders |
37
+ | **🎨 Clean UI** | Gradio Blocks for seamless text input & output |
38
+ | **☁️ Instant Deploy** | Push three files—Spaces auto-builds & hosts your demo |
39
+
40
+ ---
41
+
42
+ ## 🏗️ Architecture & Workflow
43
+
44
+ 1. **User Input** – Paste or type in any long-form text.
45
+ 2. **Summarization Pipeline** – FFN-based encoder-decoder distills the core idea.
46
+ 3. **Parameter Controls** – Adjust `max_length`/`min_length` for conciseness.
47
+ 4. **UI Rendering** – Gradio displays the summary for instant copy/paste.
48
+
49
+ All computation occurs **locally in the Space**, ensuring **privacy** and **zero API costs**.
50
+
51
+ ---
52
+
53
+ ## 🛠️ Local Development
54
+
55
+ ```bash
56
+ git clone https://github.com/your-username/text-summarizer.git
57
+ cd text-summarizer
58
+ python3 -m venv venv && source venv/bin/activate
59
+ pip install -r requirements.txt
60
+ python app.py
61