Description

Ce projet est un exemple de déploiement du modèle de machine learning de prédiction de churn. Le projet se compose de deux applications dockerisées :

• une API avec le framework Fastapi
• une application Web avec le framework Flask

Démarrage rapide

Exécution de l'application dans un conteneur

• Installer ou mettre à jour Docker et Docker Compose pour disposer des dernières versions
• Installer make avec sudo apt-get install make
• Cloner le repo et aller dans le répertoire racine et exécuter make up

L'interface Web pour la prédiction de churn est à présent accessible à l'adresse suivante: http://127.0.0.1:8020/

La documentation de l'API est accessible à l'adresse suivante: http://127.0.0.1:8000/docs

Pour arrêter les services: make stop

Développement

Structure des répertoires

sklearn_fastapi_docker        # racine du projet  
├─ backend/                   # code de l'API et de du script train.py qui entraine et sauvegarde le modèle  
│  ├─ app/  
│  │  ├─ core/  
│  │  │  ├─ schemas/          # schémas pydendic  
│  │  │  ├─ settings.py       # fichier de configuration  
│  │  ├─ datasets/            # datasets pour l'entrainement  
│  │  ├─ helpers/             # fonctions utilitaires  
│  │  ├─ modeles/             # contient le modèle de ML généré, la dernière version du modèle, et l'historique du scoring  
│  │  ├─ tests/  
│  │  │  ├─ fixtures/         # données de tests  
│  │  │  │  ├─ datasets/  
│  │  │  ├─ modeles/          # contient le modèle de ML généré, la dernière version du modèle, et l'historique du scoring  
      
├─ frontend/                  # code de la Webapp (UI)  
│  ├─ app/  
│  │  ├─ statics/             # éléments statiques: css, javascript, images ...  
│  │  │  ├─ styles/  
│  │  ├─ templates/           # templates flask

Environnement virtuel

Installer virtualenv: $ pip install virtualenv

Vous pouvez installer un environnement virtuel pour chacune des applications. Lorsque vous êtes dans l'un des répertoires frontend ou backend, exécuter :

$ virtualenv venv

puis

$ source venv/bin/activate

pour activer un environnement virtuel.

Backend

Installation des dépendances

$  cd backend/app
$ pip install -r requirements.txt
$  python train/train.py

Entrainement et sauvegarde du modèle

$  cd backend/app
$  python train/train.py

Le modèle sera sauvegardé dans le répertoire model.

API endpoints

Lancer le serveur

Dans le répertoire backend/app, exécuter :

$ uvicorn main:app --host 0.0.0.0 --port 8000 --reload --debug

Vous pouvez tester les différents endpoints à l'adresse : http://localhost:8000/docs ou http://<l'ip publique de votre machine>:8000/docs

Pour trouver l'ip pubique de votre serveur, exécuter curl ifconfig.me dans la ligne de commande du terminal.

Frontend - Webapp

Lancer l'application

Dans le répertoire frontend/app, exécuter :

$ python main.py

L'application est disponible à l'adresse suivante : http://localhost:5000/

Test auto

Exécuter la commande pytest n'importe où dans le répertoire backend