Merge pull request #39 from se4ai2526-uniba/docs_update

README.md

@@ -82,7 +82,8 @@ graph TB
 | 🏗️ [Design Choices](docs/design_choices.md) | Technical decisions & rationale |
 | 🎯 [ML Canvas](docs/ML%20Canvas.md) | Requirements engineering framework |
 | ✅ [Testing & Validation](docs/testing_and_validation.md) | QA strategy & results |
-
+| 📊 [Model Card](models/README.md) | Model details & performance |
+| 📊 [Dataset Card](data/README.md) | Dataset details & preprocessing |
 ---
 
 ## Quick Start
@@ -100,7 +101,7 @@ cp .env.example .env
 docker compose -f docker/docker-compose.yml up -d --build
 ```
 
-**Access:**
+**Access (Local):**
 - 🌐 **API Docs**: http://localhost:8080/docs
 - 🖥️ **GUI**: http://localhost:8501
 - ❤️ **Health**: http://localhost:8080/health
@@ -162,11 +163,12 @@ curl -X POST "http://localhost:8080/predict" \
 ---
 
 ## Live Deployment
-
-- **Application**: https://dacrow13-hopcroft-skill-classification.hf.space
+- **API**: https://dacrow13-hopcroft-skill-classification.hf.space/docs
+- **GUI**: https://dacrow13-hopcroft-skill-classification.hf.space
 - **MLflow**: https://dagshub.com/se4ai2526-uniba/Hopcroft/experiments
 - **Prometheus**: https://dacrow13-hopcroft-skill-classification.hf.space/prometheus/
-- **Grafana**: 
+- **Grafana**: https://dacrow13-hopcroft-skill-classification.hf.space/grafana/
+- **Betterstack**: Alerting configured. [Alert System Evidence](monitoring/screenshots)
 
 ---
 

docs/testing_and_validation.md

@@ -22,9 +22,6 @@ Behavioral testing evaluates the model's capabilities and robustness beyond simp
 | **Directional Tests** | 10 | **Passed** | Verify that specific changes to the input cause expected changes in the output (e.g., adding specific keywords should increase probability of related skills). |
 | **Minimum Functionality Tests** | 17 | **Passed** | Check basic capabilities and sanity checks (e.g., simple inputs produce valid outputs). |
 
-### Technical Notes
-- **Training Tests Excluded:** `test_model_training.py` was excluded from the run due to a missing PyTorch dependency in the environment, but the inference tests cover the model's behavior fully.
-- **Robustness:** The model demonstrates excellent consistency across all 36 behavioral scenarios.
 
 ### How to Regenerate
 To run the behavioral tests and generate the JSON report:

docs/user_guide.md

@@ -14,7 +14,7 @@ Complete operational guide for the Hopcroft Skill Classification system covering
 
 ---
 
-## 1. System Setup
+## 1. System Setup (Local)
 
 ### Prerequisites
 
@@ -25,7 +25,7 @@ Complete operational guide for the Hopcroft Skill Classification system covering
 | Docker Compose | 2.0+ | Multi-service orchestration |
 | Git | 2.30+ | Version control |
 
-### Option A: Docker Setup (Recommended)
+### Option A: Docker Setup
 
 **1. Clone and Configure**
 
@@ -122,7 +122,7 @@ streamlit run hopcroft_skill_classification_tool_competition/streamlit_app.py
 |-------------|-----|
 | Local (Docker) | http://localhost:8080 |
 | Local (Dev) | http://localhost:8000 |
-| Production (HF Spaces) | https://dacrow13-hopcroft-skill-classification.hf.space|
+| Production (HF Spaces) | https://dacrow13-hopcroft-skill-classification.hf.space/docs|
 
 ### Endpoints Overview
 
@@ -342,6 +342,8 @@ locust --headless \
 | 95th Percentile | Worst-case latency | < 2s |
 | Failure Rate | Percentage of errors | < 1% |
 
+![Locust Results](./img/locust.png)
+
 ---
 
 ## 5. Monitoring (Prometheus & Grafana)