Ajout du fichier README.md avec description du projet

This commit is contained in:
spham 2025-06-08 00:20:00 +02:00
parent d62d1e91a0
commit 0d41796ee1

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# FastAPI Project
API REST développée avec FastAPI pour la gestion et la prédiction de modèles de machine learning.
## Fonctionnalités
- API REST avec documentation automatique (Swagger UI)
- Endpoints pour la prédiction de modèles ML
- Validation des données avec Pydantic
- Documentation complète avec MkDocs
## Documentation
Consultez le dossier `docs/` pour la documentation complète du projet, ou générez-la avec MkDocs :
```bash
mkdocs build
mkdocs serve # Pour prévisualiser localement
```
## Démarrage rapide
```bash
# Installation des dépendances
pip install -r requirements.txt
# Lancement du serveur
uvicorn main:app --reload
```
Accédez à l'API via http://localhost:8000 et à la documentation via http://localhost:8000/docs