ASI-Engineer commited on
Commit
74e4534
·
verified ·
1 Parent(s): dee4df6

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +9 -21
README.md CHANGED
@@ -42,7 +42,7 @@ pinned: false
42
  - [Auteurs](#-auteurs)
43
  - [Licence](#-licence)
44
 
45
- > **Note**: La documentation de la mission OpenClassrooms est archivée dans [`docs/etapes_archive.txt`](docs/etapes_archive.txt). Les dépendances complètes (transitives) sont listées dans [`requirements_dev.txt`](requirements_dev.txt) pour installation de développement complet.
46
 
47
  ---
48
 
@@ -75,7 +75,7 @@ API REST performante exposant un modèle **XGBoost optimisé** avec :
75
  | **Precision** | 0.82 | 82% des prédictions "départ" sont correctes |
76
  | **ROC AUC** | 0.91 | Excellente capacité de discrimination |
77
 
78
- 📊 Voir [docs/MODEL_TECHNICAL.md](docs/MODEL_TECHNICAL.md) pour analyse détaillée.
79
 
80
  ### Fonctionnalités Clés
81
 
@@ -179,12 +179,6 @@ OC_P5/
179
  ├── scripts/ # 🔧 Scripts utilitaires
180
  │ ├── create_db.py # Création base PostgreSQL
181
  │ └── insert_dataset.py # Insertion données
182
- ├── docs/ # 📚 Documentation complète
183
- │ ├── API_GUIDE.md # Guide API détaillé
184
- │ ├── MODEL_TECHNICAL.md # Doc technique modèle
185
- │ ├── DEPLOYMENT.md # Guide déploiement
186
- │ ├── TRAINING.md # Guide entraînement
187
- │ └── database_guide.md # Guide PostgreSQL
188
  ├── docs/ # 📚 Documentation (5 fichiers minimaux)
189
  │ ├── architecture.md # 🏗️ Vue d'ensemble architecture + schéma BDD
190
  │ ├── api_documentation.md # 📡 Endpoints REST + exemples cURL/Python
@@ -505,7 +499,7 @@ if response.status_code == 200:
505
  print(f"Niveau: {result['risk_level']}")
506
  ```
507
 
508
- 📚 **Documentation complète** : [docs/API_GUIDE.md](docs/API_GUIDE.md)
509
 
510
  ---
511
 
@@ -661,7 +655,7 @@ docker run -d \
661
  curl http://localhost:8000/health
662
  ```
663
 
664
- 📖 **Guide complet** : [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md)
665
 
666
  ---
667
 
@@ -745,7 +739,7 @@ for col in ['age', 'revenu_mensuel', 'annees_dans_l_entreprise']:
745
  # → Déclencher ré-entraînement
746
  ```
747
 
748
- 📖 **Guide complet** : [docs/MODEL_TECHNICAL.md](docs/MODEL_TECHNICAL.md#maintenance-et-mise-à-jour)
749
 
750
  ---
751
 
@@ -849,22 +843,16 @@ Voir [pyproject.toml](pyproject.toml) pour la liste complète.
849
  ## 🔄 Changelog
850
 
851
  ### v3.3.0 (Janvier 2026)
852
- - 📚 **Documentation complète** pour Étape 6 OpenClassrooms
853
- - 📝 Création de 13 nouveaux fichiers de documentation (~5000 lignes)
854
- - 🌐 Setup site MkDocs avec theme Material (17 pages HTML)
855
- - 📊 Inventaire complet de la documentation existante
856
- - 🔧 README restructuré selon Best-README-Template (841 lignes)
857
- - 📖 Guide API exhaustif avec 7 exemples (curl, Python, JS) - 981 lignes
858
- - 🤖 Documentation technique modèle avec diagrammes et justifications - 393 lignes
859
- - 📈 Visualisation des performances du modèle (model_performance.png)
860
- - ✅ Vérification complète : liens, cohérence, instructions testées
861
 
862
  ### v3.2.1 (Janvier 2026)
863
  - 🎛️ Sliders Gradio et schémas Pydantic alignés sur les min/max réels des données d'entraînement
864
  - 📦 Endpoint batch CSV (3 fichiers bruts)
865
  - 🔑 Authentification API Key (prod)
866
  - 🔧 Correction preprocessing (scaling, ordre des colonnes)
867
- - 📝 Documentation complète enrichie (API_GUIDE, MODEL_TECHNICAL)
868
 
869
  ### v2.2.0 (27 Décembre 2025)
870
  - 📦 Nouvel endpoint `/predict/batch` pour traitement CSV direct
 
42
  - [Auteurs](#-auteurs)
43
  - [Licence](#-licence)
44
 
45
+ > **Note**: Les dépendances complètes (transitives) sont listées dans [`requirements_dev.txt`](requirements_dev.txt) pour installation de développement complet.
46
 
47
  ---
48
 
 
75
  | **Precision** | 0.82 | 82% des prédictions "départ" sont correctes |
76
  | **ROC AUC** | 0.91 | Excellente capacité de discrimination |
77
 
78
+
79
 
80
  ### Fonctionnalités Clés
81
 
 
179
  ├── scripts/ # 🔧 Scripts utilitaires
180
  │ ├── create_db.py # Création base PostgreSQL
181
  │ └── insert_dataset.py # Insertion données
 
 
 
 
 
 
182
  ├── docs/ # 📚 Documentation (5 fichiers minimaux)
183
  │ ├── architecture.md # 🏗️ Vue d'ensemble architecture + schéma BDD
184
  │ ├── api_documentation.md # 📡 Endpoints REST + exemples cURL/Python
 
499
  print(f"Niveau: {result['risk_level']}")
500
  ```
501
 
502
+ 📚 **Documentation API** : [docs/api_documentation.md](docs/api_documentation.md)
503
 
504
  ---
505
 
 
655
  curl http://localhost:8000/health
656
  ```
657
 
658
+ 📖 **Guide complet** : [docs/deployment_guide.md](docs/deployment_guide.md)
659
 
660
  ---
661
 
 
739
  # → Déclencher ré-entraînement
740
  ```
741
 
742
+ 📖 **Détails modèle & maintenance** : inclus dans [docs/architecture.md](docs/architecture.md) (section Pipeline ML) et [docs/tests_report.md](docs/tests_report.md) pour les vérifications automatiques.
743
 
744
  ---
745
 
 
843
  ## 🔄 Changelog
844
 
845
  ### v3.3.0 (Janvier 2026)
846
+ - 📚 Documentation minimaliste consolidée en 5 fichiers (architecture, API, BDD, tests, déploiement)
847
+ - 🧹 Suppression des documents redondants et archives pour alléger la page HF
848
+ - 📝 README simplifié avec navigation claire vers la nouvelle doc
 
 
 
 
 
 
849
 
850
  ### v3.2.1 (Janvier 2026)
851
  - 🎛️ Sliders Gradio et schémas Pydantic alignés sur les min/max réels des données d'entraînement
852
  - 📦 Endpoint batch CSV (3 fichiers bruts)
853
  - 🔑 Authentification API Key (prod)
854
  - 🔧 Correction preprocessing (scaling, ordre des colonnes)
855
+ - 📝 Documentation mise à jour (API, modèle)
856
 
857
  ### v2.2.0 (27 Décembre 2025)
858
  - 📦 Nouvel endpoint `/predict/batch` pour traitement CSV direct