PaulSouvik commited on
Commit
b72364a
Β·
verified Β·
1 Parent(s): c076cbb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +27 -0
README.md CHANGED
@@ -10,5 +10,32 @@ pinned: false
10
  license: apache-2.0
11
  short_description: πŸš€ Real-time sentiment classifier with Transformers & Gradio
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: πŸš€ Real-time sentiment classifier with Transformers & Gradio
12
  ---
13
+ # Real-Time Text Sentiment Classifier πŸš€
14
+
15
+ This project is a real-time sentiment analysis app built using a pre-trained Hugging Face model and deployed with **Gradio**.
16
+
17
+ ## πŸ” About the Model
18
+ - **Pipeline**: `text-classification`
19
+ - **Task**: Binary Sentiment Classification (Positive / Negative)
20
+ - **Model**: Pre-trained Transformer fine-tuned for sentiment analysis
21
+
22
+ ## 🧠 Features
23
+ - Detects sentiment (Positive/Negative) from text inputs.
24
+ - Lightweight and fast β€” great for real-time feedback apps.
25
+ - Clean UI built with Gradio for web-based interaction.
26
+
27
+ ## βš™οΈ Instructions for Users
28
+ > This model is trained for binary sentiment classification β€” Positive and Negative only.
29
+ > Neutral or mixed opinions may be interpreted as leaning toward one side.
30
+ > For best results, input clearly positive or negative sentences.
31
+ >
32
+ > **Example**:
33
+ > βœ… "I love the features of this app!"
34
+ > ❌ "The app was okay, I guess."
35
+
36
+ ## πŸš€ How to Run Locally
37
+ Install dependencies:
38
+ ```bash
39
+ pip install -r requirements.txt
40
 
41
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference