Sadeep Sachintha commited on
Commit Β·
d070015
1
Parent(s): 0c26380
docs: update readme to reflect new web ui
Browse files
README.md
CHANGED
|
@@ -23,6 +23,7 @@ An automated, scalable, and production-ready REST API for Sinhala Sentiment Anal
|
|
| 23 |
## π Key Features
|
| 24 |
|
| 25 |
- **π§ Native Sinhala NLP:** Utilizes `keshan/sinhala-sentiment-analysis` for accurate sentiment detection (Positive/Negative) in Sinhala text.
|
|
|
|
| 26 |
- **β‘ High-Performance Backend:** Built with **FastAPI** and **Uvicorn**, ensuring rapid response times, data validation via Pydantic, and automatic OpenAPI documentation.
|
| 27 |
- **π³ Containerized Portability:** Fully Dockerized. The model is downloaded and cached during the Docker build stage for lightning-fast container startup.
|
| 28 |
- **βοΈ CI/CD Automation:** A robust **GitHub Actions** pipeline automatically tests the codebase and deploys the latest version to a free Hugging Face Docker Space upon merging to `main`.
|
|
@@ -79,14 +80,9 @@ uvicorn app.main:app --host 0.0.0.0 --port 7860 --reload
|
|
| 79 |
|
| 80 |
Once the server is running, you can access the interactive Swagger UI at: `http://localhost:7860/docs`
|
| 81 |
|
| 82 |
-
### 1.
|
| 83 |
- **Endpoint:** `GET /`
|
| 84 |
-
- **
|
| 85 |
-
```json
|
| 86 |
-
{
|
| 87 |
-
"message": "Welcome to the Sinhala Sentiment Analysis API. Use POST /predict to analyze text."
|
| 88 |
-
}
|
| 89 |
-
```
|
| 90 |
|
| 91 |
### 2. Predict Sentiment
|
| 92 |
- **Endpoint:** `POST /predict`
|
|
|
|
| 23 |
## π Key Features
|
| 24 |
|
| 25 |
- **π§ Native Sinhala NLP:** Utilizes `keshan/sinhala-sentiment-analysis` for accurate sentiment detection (Positive/Negative) in Sinhala text.
|
| 26 |
+
- **β¨ Interactive Web UI:** Features a premium, dark-mode frontend built with modern glassmorphism design, allowing users to analyze text directly in their browser.
|
| 27 |
- **β‘ High-Performance Backend:** Built with **FastAPI** and **Uvicorn**, ensuring rapid response times, data validation via Pydantic, and automatic OpenAPI documentation.
|
| 28 |
- **π³ Containerized Portability:** Fully Dockerized. The model is downloaded and cached during the Docker build stage for lightning-fast container startup.
|
| 29 |
- **βοΈ CI/CD Automation:** A robust **GitHub Actions** pipeline automatically tests the codebase and deploys the latest version to a free Hugging Face Docker Space upon merging to `main`.
|
|
|
|
| 80 |
|
| 81 |
Once the server is running, you can access the interactive Swagger UI at: `http://localhost:7860/docs`
|
| 82 |
|
| 83 |
+
### 1. Access the Web Interface
|
| 84 |
- **Endpoint:** `GET /`
|
| 85 |
+
- **Description:** Returns the beautiful, interactive HTML frontend where you can type Sinhala sentences and see real-time sentiment predictions.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 86 |
|
| 87 |
### 2. Predict Sentiment
|
| 88 |
- **Endpoint:** `POST /predict`
|