ASI-Engineer commited on
Commit
dee4df6
·
verified ·
1 Parent(s): 8a709cb

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +20 -10
README.md CHANGED
@@ -185,6 +185,12 @@ OC_P5/
185
  │ ├── DEPLOYMENT.md # Guide déploiement
186
  │ ├── TRAINING.md # Guide entraînement
187
  │ └── database_guide.md # Guide PostgreSQL
 
 
 
 
 
 
188
  ├── data/ # 📊 Données sources (1470 employés)
189
  │ ├── extrait_sondage.csv # Données satisfaction
190
  │ ├── extrait_eval.csv # Données évaluations
@@ -797,16 +803,20 @@ open htmlcov/index.html
797
 
798
  ## 📚 Documentation
799
 
800
- | Document | Description |
801
- |----------|-------------|
802
- | [📖 README.md](README.md) | Vue d'ensemble et guide rapide (ce fichier) |
803
- | [🔌 API_GUIDE.md](docs/API_GUIDE.md) | Guide complet de l'API (endpoints, schémas, exemples) |
804
- | [🤖 MODEL_TECHNICAL.md](docs/MODEL_TECHNICAL.md) | Documentation technique du modèle (architecture, performances, maintenance) |
805
- | [🚀 DEPLOYMENT.md](docs/DEPLOYMENT.md) | Guide de déploiement (Docker, HF Spaces, CI/CD) |
806
- | [🎓 TRAINING.md](docs/TRAINING.md) | Guide d'entraînement du modèle (preprocessing, MLflow) |
807
- | [🗄️ database_guide.md](docs/database_guide.md) | Guide PostgreSQL pour débutants |
808
- | [📊 DOCUMENTATION_INVENTORY.md](docs/DOCUMENTATION_INVENTORY.md) | Inventaire complet de la documentation |
809
- | [📐 schema.puml](docs/schema.puml) | Diagramme UML de la base de données |
 
 
 
 
810
 
811
  **Documentation interactive** :
812
  - 🌐 **Swagger UI** : http://localhost:8000/docs
 
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
191
+ │ ├── database_setup.md # 🗄️ Setup PostgreSQL + requêtes SQL
192
+ │ ├── tests_report.md # 🧪 Couverture tests (73%) + résultats
193
+ │ └── deployment_guide.md # 🚀 CI/CD + déploiement HF Spaces
194
  ├── data/ # 📊 Données sources (1470 employés)
195
  │ ├── extrait_sondage.csv # Données satisfaction
196
  │ ├── extrait_eval.csv # Données évaluations
 
803
 
804
  ## 📚 Documentation
805
 
806
+
807
+ ### Navigation dans le dossier `docs/`
808
+
809
+ Documentation **minimaliste et structurée** en **5 fichiers** couvrant tous les aspects du projet :
810
+
811
+ | Document | Description | Étapes OC |
812
+ |----------|-------------|-----------|
813
+ | [🏗️ architecture.md](docs/architecture.md) | Vue d'ensemble du projet, schéma architecture, diagramme BDD (PlantUML), flux de données | Étape 4, 6 |
814
+ | [📡 api_documentation.md](docs/api_documentation.md) | Documentation API REST : endpoints, schémas Pydantic, exemples cURL/Python, codes erreurs | Étape 3, 6 |
815
+ | [🗄️ database_setup.md](docs/database_setup.md) | Configuration PostgreSQL, scripts création BDD, requêtes SQL utiles, sauvegarde/restauration | Étape 4 |
816
+ | [🧪 tests_report.md](docs/tests_report.md) | Rapport de couverture (73%), détail des 48 tests unitaires/fonctionnels, commandes pytest | Étape 5 |
817
+ | [🚀 deployment_guide.md](docs/deployment_guide.md) | CI/CD GitHub Actions, déploiement HuggingFace Spaces, gestion secrets, monitoring | Étape 2, 6 |
818
+
819
+ **Choix de conception** : Documentation concise (1-2 pages par fichier) privilégiant la **clarté** et **l'actionnable** sur l'exhaustivité.
820
 
821
  **Documentation interactive** :
822
  - 🌐 **Swagger UI** : http://localhost:8000/docs