Spaces:
Running
Running
Upload folder using huggingface_hub
Browse files- README.md +20 -10
- mkdocs.yml +9 -19
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 |
-
|
| 801 |
-
|
| 802 |
-
|
| 803 |
-
|
| 804 |
-
|
| 805 |
-
|
|
| 806 |
-
|
| 807 |
-
| [
|
| 808 |
-
| [
|
| 809 |
-
| [
|
|
|
|
|
|
|
|
|
|
|
|
|
| 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
|
mkdocs.yml
CHANGED
|
@@ -147,28 +147,18 @@ extra:
|
|
| 147 |
|
| 148 |
# Navigation
|
| 149 |
nav:
|
| 150 |
-
- Accueil:
|
| 151 |
-
- Vue d'ensemble: index.md
|
| 152 |
-
- Changelog: changelog.md
|
| 153 |
|
| 154 |
-
- Guide
|
| 155 |
- Installation: installation.md
|
| 156 |
- Configuration: configuration.md
|
| 157 |
-
-
|
| 158 |
-
|
| 159 |
-
|
| 160 |
-
-
|
| 161 |
-
|
| 162 |
-
- Modèle ML:
|
| 163 |
-
- Documentation technique: MODEL_TECHNICAL.md
|
| 164 |
-
- Guide d'entraînement: TRAINING.md
|
| 165 |
-
|
| 166 |
-
- Déploiement:
|
| 167 |
-
- Guide de déploiement: DEPLOYMENT.md
|
| 168 |
-
|
| 169 |
-
- Base de Données:
|
| 170 |
-
- Guide de la base de données: database_guide.md
|
| 171 |
|
| 172 |
- Référence:
|
| 173 |
-
-
|
|
|
|
| 174 |
- Archive mission OC: etapes_archive.txt
|
|
|
|
|
|
| 147 |
|
| 148 |
# Navigation
|
| 149 |
nav:
|
| 150 |
+
- Accueil: index.md
|
|
|
|
|
|
|
| 151 |
|
| 152 |
+
- Guide:
|
| 153 |
- Installation: installation.md
|
| 154 |
- Configuration: configuration.md
|
| 155 |
+
- API: api.md
|
| 156 |
+
- Modèle ML: model.md
|
| 157 |
+
- Entraînement: training.md
|
| 158 |
+
- Déploiement: deployment.md
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 159 |
|
| 160 |
- Référence:
|
| 161 |
+
- Changelog: changelog.md
|
| 162 |
+
- Base de données: database_guide.md
|
| 163 |
- Archive mission OC: etapes_archive.txt
|
| 164 |
+
|