Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
@@ -1,61 +1,22 @@
|
|
1 |
-
#
|
2 |
|
3 |
-
|
4 |
-
- Jishen Wang
|
5 |
-
- Shen Yishan
|
6 |
|
7 |
-
##
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
12 |
-
βββ docs/ # Documentation
|
13 |
-
β βββ project_report.md # Project report in markdown format
|
14 |
-
β βββ project_report.pdf # Project report in PDF format
|
15 |
-
βββ src/ # Source code
|
16 |
-
β βββ app.py # Streamlit web application
|
17 |
-
β βββ model.py # Sentiment analysis model implementation
|
18 |
-
β βββ preprocessing.py # Text preprocessing utilities
|
19 |
-
β βββ utils.py # General utility functions
|
20 |
-
βββ data/ # Data directory for storing datasets
|
21 |
-
βββ notebooks/ # Jupyter notebooks for analysis
|
22 |
-
```
|
23 |
-
|
24 |
-
## Setup Instructions
|
25 |
-
1. Clone this repository
|
26 |
-
2. Install dependencies:
|
27 |
-
```bash
|
28 |
-
pip install -r requirements.txt
|
29 |
-
```
|
30 |
-
|
31 |
-
## Running the Application
|
32 |
-
1. Navigate to the project directory:
|
33 |
-
```bash
|
34 |
-
cd ISOM5240_Project
|
35 |
-
```
|
36 |
-
|
37 |
-
2. Run the Streamlit application:
|
38 |
-
```bash
|
39 |
-
streamlit run src/app.py
|
40 |
-
```
|
41 |
-
|
42 |
-
3. Access the web interface at: http://localhost:8501
|
43 |
-
|
44 |
-
## Documentation
|
45 |
-
- Detailed project documentation can be found in the `docs` directory
|
46 |
-
- The project report is available in both markdown and PDF formats
|
47 |
|
48 |
## Model Information
|
49 |
-
|
50 |
-
- Multi-language support for sentiment analysis
|
51 |
-
- Real-time analysis through web interface
|
52 |
|
53 |
-
##
|
54 |
-
1.
|
55 |
-
2.
|
56 |
-
3.
|
57 |
-
4. Web interface for real-time analysis
|
58 |
-
5. Batch processing capabilities
|
59 |
-
6. Results visualization and export options
|
60 |
|
61 |
-
|
|
|
|
|
|
|
|
1 |
+
# Amazon Review Sentiment Analysis
|
2 |
|
3 |
+
This Streamlit application analyzes the sentiment of product reviews and predicts ratings (1-5 stars) using a pre-trained model from Hugging Face.
|
|
|
|
|
4 |
|
5 |
+
## Features
|
6 |
+
- Real-time sentiment analysis of product reviews
|
7 |
+
- Rating prediction (1-5 stars)
|
8 |
+
- Confidence scores for each rating
|
9 |
+
- Multi-language support (English, Dutch, German, French, Spanish, Italian)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
10 |
|
11 |
## Model Information
|
12 |
+
The application uses the [LiYuan/amazon-review-sentiment-analysis](https://huggingface.co/LiYuan/amazon-review-sentiment-analysis) model from Hugging Face, which is based on DistilBERT and was trained on a large dataset of Amazon product reviews.
|
|
|
|
|
13 |
|
14 |
+
## Usage
|
15 |
+
1. Enter your review text in the text area
|
16 |
+
2. Click "Analyze Sentiment"
|
17 |
+
3. View the predicted rating and confidence scores
|
|
|
|
|
|
|
18 |
|
19 |
+
## Technical Details
|
20 |
+
- Built with Streamlit
|
21 |
+
- Uses PyTorch and Transformers
|
22 |
+
- Model is cached for faster inference
|