ghostai1 commited on
Commit
64f9c8f
·
verified ·
1 Parent(s): 6b7450a

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 Zero-Shot Text Classification'
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 Zero-Shot Text Classification'
12
  ---
13
+ # 🏷️ Zero-Shot Text Classification
14
+ [![Hugging Face Space](https://img.shields.io/badge/HuggingFace-Spaces-blue?logo=huggingface)](https://huggingface.co/spaces/your-username/zero-shot-classifier)
15
+ [![Gradio UI](https://img.shields.io/badge/Gradio-5.31.0-brightgreen?logo=gradio)]
16
+ [![Model](https://img.shields.io/badge/Model-BART--MNLI-orange)](https://huggingface.co/facebook/bart-large-mnli)
17
+ [![License](https://img.shields.io/badge/License-MIT-lightgrey)](LICENSE)
18
 
19
+ ---
20
+
21
+ ## 🚀 Overview
22
+ Unlock **zero-shot classification** for any text—no fine-tuning required.
23
+ Define your own label set on the fly and see how well each label matches your input, powered by **BART-MNLI** on CPU.
24
+
25
+ > **AI buzzwords:**
26
+ > Natural Language Inference • Zero‐shot Learning • Transformer-based NLP • Real-time Inference • Edge Deployment • Cloud-native Demo
27
+
28
+ ---
29
+
30
+ ## ✨ Features
31
+
32
+ | 🔑 Feature | 🔍 Description |
33
+ |--------------------------------|----------------------------------------------------------------|
34
+ | **🚀 Zero-Shot** | Classify into arbitrary categories without task-specific data |
35
+ | **⚡ CPU-Only Inference** | Runs on free Hugging Face Spaces (2 vCPU / 16 GB RAM) |
36
+ | **🎛️ Single vs. Multi-Label** | Toggle between exclusive or overlapping labels |
37
+ | **🎨 Interactive UI** | Gradio Blocks with text input, label list, mode toggle, table |
38
+ | **🔧 No Training Needed** | Leverages pre-trained BART-MNLI via HF Transformers |
39
+ | **☁️ Instant Deploy** | Commit three files—Spaces auto-builds & hosts your demo |
40
+
41
+ ---
42
+
43
+ ## 🏗️ How It Works
44
+
45
+ 1. **User Input** – Paste any sentence or paragraph.
46
+ 2. **Label Definition** – Enter comma-separated candidate labels (e.g. “Positive, Negative, Question”).
47
+ 3. **Model Inference** – Pipeline computes entailment scores for each label.
48
+ 4. **Result Table** – Display each label with its confidence score.
49
+
50
+ All done **locally on the Space**, ensuring **privacy**, **zero API cost**, and **lightning speed**.
51
+
52
+ ---
53
+
54
+ ## 🛠️ Local Development
55
+
56
+ ```bash
57
+ git clone https://github.com/your-username/zero-shot-classifier.git
58
+ cd zero-shot-classifier
59
+ python3 -m venv venv && source venv/bin/activate
60
+ pip install -r requirements.txt
61
+ python app.py