Upload folder using huggingface_hub

README.md

@@ -1,49 +1,239 @@
----
-title: Employee Turnover Prediction API
-emoji: 👔
-colorFrom: blue
-colorTo: purple
-sdk: docker
-pinned: true
-license: mit
-app_port: 8000
----
+# 🚀 Employee Turnover Prediction API - v2.1.0
 
-# Employee Turnover Prediction API 🚀
+## 📊 Vue d'ensemble
 
-API de prédiction du turnover des employés avec XGBoost + SMOTE.
+API REST de prédiction du turnover des employés basée sur un modèle XGBoost avec SMOTE.
 
-## 🎯 Fonctionnalités
-
-- ✅ Prédiction de turnover (0 = reste, 1 = part)
-- 📊 Probabilités et niveau de risque (Low/Medium/High)
+**✨ Nouveautés v2.1.0** :
+- 📝 Logging structuré JSON
+- 🛡️ Rate limiting (20 req/min par IP)
+- ⚡ Gestion d'erreurs améliorée
+- 📊 Monitoring des performances
 - 🔐 Authentification API Key
-- 📝 Logs structurés JSON
-- 🛡️ Rate limiting (20 req/min)
-- 📚 Documentation OpenAPI/Swagger
 
-## 🔗 Endpoints
+## 🏗️ Architecture
+
+```
+OC_P5/
+├── app.py                    # Point d'entrée FastAPI
+├── src/
+│   ├── auth.py              # Authentification API Key
+│   ├── config.py            # Configuration centralisée
+│   ├── logger.py            # Logging structuré (NOUVEAU)
+│   ├── models.py            # Chargement modèle HF Hub
+│   ├── preprocessing.py     # Pipeline preprocessing
+│   ├── rate_limit.py        # Rate limiting (NOUVEAU)
+│   └── schemas.py           # Validation Pydantic
+├── tests/                   # Suite pytest (33 tests, 88% couverture)
+├── logs/                    # Logs JSON (NOUVEAU)
+│   ├── api.log              # Tous les logs
+│   └── error.log            # Erreurs uniquement
+├── docs/                    # Documentation
+├── ml_model/                # Scripts training
+└── data/                    # Données sources
+```
+
+## 🚀 Installation
+
+### Prérequis
+- Python 3.12+
+- Poetry 1.7+
+- Git
+
+### Setup rapide
+
+```bash
+# 1. Cloner le repo
+git clone https://github.com/chaton59/OC_P5.git
+cd OC_P5
+
+# 2. Installer les dépendances
+poetry install
+
+# 3. Configurer l'environnement
+cp .env.example .env
+# Éditer .env avec vos valeurs
+
+# 4. Lancer l'API
+poetry run uvicorn app:app --reload
 
-- **Docs** : `/docs` - Documentation interactive
-- **Health** : `/health` - Status de l'API
-- **Predict** : `/predict` - Prédiction de turnover
+# 5. Accéder à la documentation
+# http://localhost:8000/docs
+```
 
-## 🚀 Utilisation
+## 📝 Configuration (.env)
 
 ```bash
-# Health check
-curl https://asi-engineer-employee-turnover-api.hf.space/health
+# Mode développement (désactive auth + active logs détaillés)
+DEBUG=true
+
+# API Key (requis en production)
+API_KEY=your-secret-key-here
 
-# Prédiction
-curl -X POST https://asi-engineer-employee-turnover-api.hf.space/predict \
+# Logging (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+LOG_LEVEL=INFO
+
+# HuggingFace Model
+HF_MODEL_REPO=ASI-Engineer/employee-turnover-model
+MODEL_FILENAME=model/model.pkl
+```
+
+## 🔒 Authentification
+
+### Mode DEBUG (développement)
+```bash
+# L'API Key n'est PAS requise
+curl http://localhost:8000/predict -H "Content-Type: application/json" -d '{...}'
+```
+
+### Mode PRODUCTION
+```bash
+# L'API Key est REQUISE
+curl http://localhost:8000/predict \
+  -H "X-API-Key: your-secret-key" \
   -H "Content-Type: application/json" \
-  -d '{
-    "satisfaction_employee_environnement": 3,
-    "satisfaction_employee_nature_travail": 4,
-    ...
-  }'
+  -d '{...}'
 ```
 
-## 📚 Documentation complète
+## 📡 Endpoints
+
+### 🏥 Health Check
+```bash
+GET /health
+
+# Réponse
+{
+  "status": "healthy",
+  "model_loaded": true,
+  "model_type": "Pipeline",
+  "version": "2.1.0"
+}
+```
+
+### 🔮 Prédiction
+```bash
+POST /predict
+Content-Type: application/json
+X-API-Key: your-key (en production)
+
+# Exemple payload (voir docs/API_GUIDE.md pour tous les champs)
+{
+  "satisfaction_employee_environnement": 3,
+  "satisfaction_employee_nature_travail": 4,
+  "satisfaction_employee_equipe": 5,
+  "satisfaction_employee_equilibre_pro_perso": 3,
+  "note_evaluation_actuelle": 85,
+  "annees_depuis_la_derniere_promotion": 2,
+  "nombre_formations_realisees": 3,
+  ...
+}
+
+# Réponse
+{
+  "prediction": 0,                    # 0 = reste, 1 = part
+  "probability_0": 0.85,              # Probabilité de rester
+  "probability_1": 0.15,              # Probabilité de partir
+  "risk_level": "Low"                 # Low, Medium, High
+}
+```
+
+## 📊 Logging
+
+### Logs structurés JSON
+
+**Fichiers** :
+- `logs/api.log` : Tous les logs
+- `logs/error.log` : Erreurs uniquement
+
+**Format** :
+```json
+{
+  "timestamp": "2025-12-26T10:30:45",
+  "level": "INFO",
+  "logger": "employee_turnover_api",
+  "message": "Request POST /predict",
+  "method": "POST",
+  "path": "/predict",
+  "status_code": 200,
+  "duration_ms": 23.45,
+  "client_host": "127.0.0.1"
+}
+```
+
+## 🛡️ Rate Limiting
+
+**Configuration** :
+- **Développement** : Désactivé (DEBUG=true)
+- **Production** : 20 requêtes/minute par IP ou API Key
+
+**En cas de dépassement** :
+```json
+{
+  "error": "Rate limit exceeded",
+  "message": "20 per 1 minute"
+}
+```
+
+## ✅ Tests
+
+```bash
+# Tous les tests
+poetry run pytest tests/ -v
+
+# Avec couverture
+poetry run pytest tests/ --cov --cov-report=html
+
+# Voir rapport HTML
+open htmlcov/index.html
+```
+
+**Résultats** :
+- ✅ 33 tests passés
+- 📊 88% de couverture globale
+
+## 🚀 Déploiement
+
+### Variables d'environnement requises
+```bash
+DEBUG=false
+API_KEY=<votre-clé-sécurisée>
+LOG_LEVEL=INFO
+```
+
+### HuggingFace Spaces
+Prêt pour déploiement avec `app.py` et `requirements.txt`
+
+## 📚 Documentation
+
+- **API Interactive** : http://localhost:8000/docs
+- **ReDoc** : http://localhost:8000/redoc
+- **Guide complet** : [docs/API_GUIDE.md](docs/API_GUIDE.md)
+- **Standards** : [docs/standards.md](docs/standards.md)
+- **Couverture tests** : [docs/TEST_COVERAGE.md](docs/TEST_COVERAGE.md)
+
+## 📦 Dépendances principales
+
+- **FastAPI** 0.115.14 : Framework web
+- **Pydantic** 2.12.5 : Validation données
+- **XGBoost** 2.1.3 : Modèle ML
+- **SlowAPI** 0.1.9 : Rate limiting
+- **python-json-logger** 4.0.0 : Logs structurés
+- **pytest** 9.0.2 : Tests
+
+## 🔄 Changelog
+
+### v2.1.0 (26 décembre 2025)
+- ✨ Système de logging structuré JSON
+- 🛡️ Rate limiting avec SlowAPI
+- ⚡ Amélioration gestion d'erreurs
+- 📊 Monitoring des performances
+
+### v2.0.0 (26 décembre 2025)
+- ✅ Suite de tests complète (33 tests)
+- 🔐 Authentification API Key
+- 📊 88% de couverture de code
+
+## 👥 Auteurs
 
-Voir [GitHub Repository](https://github.com/chaton59/OC_P5) pour la documentation complète.
+- **Projet** : OpenClassrooms P5
+- **Repo** : [github.com/chaton59/OC_P5](https://github.com/chaton59/OC_P5)

src/gradio_ui.py

@@ -7,23 +7,11 @@ Cette interface permet de:
 - Visualiser la documentation de l'API
 - Comprendre les champs requis
 """
-import os
-
 import gradio as gr
-import httpx
-
-from src.models import get_model_info
-
 
-# URL de base pour les appels API (localhost en dev, relatif en prod)
-def get_api_base_url() -> str:
-    """Retourne l'URL de base de l'API."""
-    # En production sur HF Spaces, utiliser le même host
-    space_host = os.getenv("SPACE_HOST")
-    if space_host:
-        return f"https://{space_host}"
-    # En local
-    return "http://localhost:8000"
+from src.models import get_model_info, load_model
+from src.preprocessing import preprocess_for_prediction
+from src.schemas import EmployeeInput
 
 
 def predict_turnover(
@@ -61,67 +49,69 @@ def predict_turnover(
     annees_dans_l_entreprise: int,
     annees_dans_le_poste_actuel: int,
 ) -> str:
-    """Effectue une prédiction de turnover via l'API REST."""
+    """Effectue une prédiction de turnover directement via le modèle."""
     try:
-        # Construire le payload pour l'API
-        payload = {
-            "nombre_participation_pee": int(nombre_participation_pee),
-            "nb_formations_suivies": int(nb_formations_suivies),
-            "nombre_employee_sous_responsabilite": int(
+        # Créer l'objet EmployeeInput avec validation Pydantic
+        employee = EmployeeInput(
+            nombre_participation_pee=int(nombre_participation_pee),
+            nb_formations_suivies=int(nb_formations_suivies),
+            nombre_employee_sous_responsabilite=int(
                 nombre_employee_sous_responsabilite
             ),
-            "distance_domicile_travail": int(distance_domicile_travail),
-            "niveau_education": int(niveau_education),
-            "domaine_etude": domaine_etude,
-            "ayant_enfants": ayant_enfants,
-            "frequence_deplacement": frequence_deplacement,
-            "annees_depuis_la_derniere_promotion": int(
+            distance_domicile_travail=int(distance_domicile_travail),
+            niveau_education=int(niveau_education),
+            domaine_etude=domaine_etude,
+            ayant_enfants=ayant_enfants,
+            frequence_deplacement=frequence_deplacement,
+            annees_depuis_la_derniere_promotion=int(
                 annees_depuis_la_derniere_promotion
             ),
-            "annes_sous_responsable_actuel": int(annes_sous_responsable_actuel),
-            "satisfaction_employee_environnement": int(
+            annes_sous_responsable_actuel=int(annes_sous_responsable_actuel),
+            satisfaction_employee_environnement=int(
                 satisfaction_employee_environnement
             ),
-            "note_evaluation_precedente": int(note_evaluation_precedente),
-            "niveau_hierarchique_poste": int(niveau_hierarchique_poste),
-            "satisfaction_employee_nature_travail": int(
+            note_evaluation_precedente=int(note_evaluation_precedente),
+            niveau_hierarchique_poste=int(niveau_hierarchique_poste),
+            satisfaction_employee_nature_travail=int(
                 satisfaction_employee_nature_travail
             ),
-            "satisfaction_employee_equipe": int(satisfaction_employee_equipe),
-            "satisfaction_employee_equilibre_pro_perso": int(
+            satisfaction_employee_equipe=int(satisfaction_employee_equipe),
+            satisfaction_employee_equilibre_pro_perso=int(
                 satisfaction_employee_equilibre_pro_perso
             ),
-            "note_evaluation_actuelle": int(note_evaluation_actuelle),
-            "heure_supplementaires": heure_supplementaires,
-            "augementation_salaire_precedente": float(augementation_salaire_precedente),
-            "age": int(age),
-            "genre": genre,
-            "revenu_mensuel": float(revenu_mensuel),
-            "statut_marital": statut_marital,
-            "departement": departement,
-            "poste": poste,
-            "nombre_experiences_precedentes": int(nombre_experiences_precedentes),
-            "nombre_heures_travailless": int(nombre_heures_travailless),
-            "annee_experience_totale": int(annee_experience_totale),
-            "annees_dans_l_entreprise": int(annees_dans_l_entreprise),
-            "annees_dans_le_poste_actuel": int(annees_dans_le_poste_actuel),
-        }
-
-        # Appeler l'API REST avec la clé API
-        api_url = get_api_base_url()
-        api_key = os.getenv("API_KEY", "")
-        headers = {"X-API-Key": api_key} if api_key else {}
-
-        with httpx.Client(timeout=30.0) as client:
-            response = client.post(f"{api_url}/predict", json=payload, headers=headers)
-            response.raise_for_status()
-            data = response.json()
-
-        # Formater le résultat
-        prediction = data["prediction"]
-        prob_1 = data["probability_1"]
-        prob_0 = data["probability_0"]
-        risk_level = data["risk_level"]
+            note_evaluation_actuelle=int(note_evaluation_actuelle),
+            heure_supplementaires=heure_supplementaires,
+            augementation_salaire_precedente=float(augementation_salaire_precedente),
+            age=int(age),
+            genre=genre,
+            revenu_mensuel=float(revenu_mensuel),
+            statut_marital=statut_marital,
+            departement=departement,
+            poste=poste,
+            nombre_experiences_precedentes=int(nombre_experiences_precedentes),
+            nombre_heures_travailless=int(nombre_heures_travailless),
+            annee_experience_totale=int(annee_experience_totale),
+            annees_dans_l_entreprise=int(annees_dans_l_entreprise),
+            annees_dans_le_poste_actuel=int(annees_dans_le_poste_actuel),
+        )
+
+        # Preprocessing
+        features = preprocess_for_prediction(employee)
+
+        # Charger le modèle et prédire
+        model = load_model()
+        prediction = int(model.predict(features)[0])
+        proba = model.predict_proba(features)[0]
+        prob_0 = float(proba[0])
+        prob_1 = float(proba[1])
+
+        # Déterminer le niveau de risque
+        if prob_1 < 0.3:
+            risk_level = "Low"
+        elif prob_1 < 0.7:
+            risk_level = "Medium"
+        else:
+            risk_level = "High"
 
         # Affichage
         if risk_level == "High":
@@ -147,10 +137,6 @@ def predict_turnover(
 """
         return result
 
-    except httpx.HTTPStatusError as e:
-        return f"❌ **Erreur API**: {e.response.status_code} - {e.response.text}"
-    except httpx.RequestError as e:
-        return f"❌ **Erreur de connexion**: {str(e)}"
     except Exception as e:
         return f"❌ **Erreur**: {str(e)}"