Diane.Aurélie commited on
Commit
d3f5d8a
·
1 Parent(s): 330f67d

docs: mise à jour README projet détaillé

Browse files
Files changed (1) hide show
  1. README.md +54 -0
README.md CHANGED
@@ -0,0 +1,54 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Futurisys – Déploiement d’un modèle de Machine Learning via API
2
+
3
+ ## Contexte
4
+ **Futurisys** est une entreprise innovante souhaitant rendre ses modèles de machine learning
5
+ opérationnels et accessibles via une API performante.
6
+
7
+ Ce projet correspond à un **Proof of Concept (POC)** visant à déployer un modèle de machine
8
+ learning en production en appliquant les bonnes pratiques d’ingénierie logicielle :
9
+ versionnage, tests, base de données et automatisation.
10
+
11
+
12
+
13
+ ## Objectifs du projet
14
+ - Déployer un modèle de machine learning via une API REST
15
+ - Rendre le modèle accessible de manière fiable et documentée
16
+ - Mettre en place une architecture maintenable et évolutive
17
+ - Appliquer un workflow Git professionnel
18
+ - Préparer une base solide pour un déploiement en production
19
+
20
+
21
+
22
+ ## Périmètre fonctionnel
23
+ Le projet inclut :
24
+ - Une API développée avec **FastAPI**
25
+ - L’exposition d’un modèle de machine learning via des endpoints REST
26
+ - Une base de données **PostgreSQL** pour stocker les entrées/sorties du modèle
27
+ - Des tests unitaires et fonctionnels avec **Pytest**
28
+ - Un pipeline **CI/CD** pour automatiser les tests et le déploiement
29
+ - Une documentation technique claire
30
+
31
+
32
+
33
+ ## Stack technique
34
+ - **Langage** : Python
35
+ - **API** : FastAPI
36
+ - **Machine Learning** : scikit-learn
37
+ - **Base de données** : PostgreSQL
38
+ - **Tests** : Pytest, pytest-cov
39
+ - **CI/CD** : GitHub Actions
40
+ - **Versionnage** : Git / GitHub
41
+
42
+
43
+
44
+ ## Structure du projet
45
+ ```text
46
+ futurisys_ml-api/
47
+ ├── app/ # Code applicatif principal
48
+ │ ├── main.py # Point d’entrée de l’API
49
+ |
50
+ ├── tests/ # Tests unitaires, fonctionnels
51
+ ├── scripts/ # Scripts bd (BD, données)
52
+ ├── requirements.txt # Librairies env.
53
+ ├── README.md # Présentation du projet
54
+ └── .gitignore # Nettoyage du dépôt