RawadAlghamdi commited on
Commit
dcb463d
·
verified ·
1 Parent(s): 75814ec

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +43 -1
README.md CHANGED
@@ -9,5 +9,47 @@ 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
+ # Sentiment Analyzer
13
 
14
+ An interactive tool for sentiment analysis using the `nlptown/bert-base-multilingual-uncased-sentiment` model. Built with Gradio and deployed on Hugging Face Spaces.
15
+
16
+ ## Features
17
+
18
+ - **Sentiment Analysis**: Predicts sentiment on a 1 to 5-star scale.
19
+ - **Multilingual Support**: Works with multiple languages.
20
+ - **User-Friendly Interface**: Simple input and output for quick analysis.
21
+ - **No Installation Required**: Use it directly online.
22
+
23
+ ## Access the App
24
+
25
+ Try it here:
26
+ [https://huggingface.co/spaces/RawadAlghamdi/sentiment-analyzer](https://huggingface.co/spaces/RawadAlghamdi/sentiment-analyzer)
27
+
28
+ ## Running Locally (Optional)
29
+
30
+ To run the app on your machine:
31
+
32
+ 1. Install dependencies:
33
+ ```bash
34
+ pip install gradio transformers torch
35
+ ```
36
+ 2. Run the application:
37
+ ```bash
38
+ python app.py
39
+ ```
40
+ 3. Open the provided local URL in your browser.
41
+
42
+ ## How It Works
43
+
44
+ 1. Enter a sentence or paragraph into the input box.
45
+ 2. Click submit to analyze the sentiment.
46
+ 3. The predicted sentiment (1 to 5 stars) appears in the output box.
47
+
48
+ ## Customization
49
+
50
+ - Replace the model in `pipeline("sentiment-analysis", model="nlptown/bert-base-multilingual-uncased-sentiment")` to test other sentiment analysis models.
51
+ - Modify `examples` to add more test inputs.
52
+
53
+ ## License
54
+
55
+ Licensed under the **Apache License 2.0**. See [LICENSE](LICENSE) for details.