openclassroom-ai/oc-p07-sentiment-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Aligner le README français sur Forgejo et l'URL de prod actuelle.

Browse source
This commit is contained in:
Grégoire Mureau 2026-09-09 12:58:44 +02:00
parent 5b58da9f01
commit 8cf6586db8
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.fr.md
View file

@ -4,6 +4,13 @@
Ce dépôt contient les notebooks et le code source du projet d'analyse de sentiments sur des tweets, réalisé dans le cadre du programme OpenClassrooms **"Air Paradis"**.
**Source de vérité** : [Forgejo](https://git.gregoiremureau.com/grgmro/oc-p07-sentiment-api) (auto-hébergé).
```bash
git clone https://git.gregoiremureau.com/grgmro/oc-p07-sentiment-api.git
git clone https://git.gregoiremureau.com/grgmro/oc-p07-sentiment-api.git
```
---
## Contexte métier
@ -33,7 +40,8 @@ Le projet vise à développer un système complet d'analyse de sentiments, compr
- `deployment/` : code de l'API FastAPI, tests unitaires, Dockerfile et configuration déploiement,
- `docs/` : documentation détaillée (blog.fr.md), diagrammes, captures d'écran,
- `presentation/` : support de présentation du projet (PDF),
- `../.github/workflows/` : pipelines CI/CD (tests automatisés, build Docker, push DockerHub).
- `.github/workflows/` : CI (Forgejo Actions sur le runner homelab ; même YAML côté GitHub),
- `fetch-data.sh` : où récupérer Sentiment140 (dataset **hors** git).
---
@ -48,7 +56,7 @@ Les phases d'entraînement ont principalement été réalisées sur **Google Col
Les notebooks détaillent les étapes d'analyse et d'entraînement.
L'API est disponible dans le dossier `deployment/api` avec interface Streamlit de test.
Pour tester l'API en production : https://sentiment-api.greg-madman-nas.duckdns.org
Pour tester l'API en production : https://api.gregoiremureau.com/ml/sentiment/
---
@ -56,6 +64,7 @@ Pour tester l'API en production : https://sentiment-api.greg-madman-nas.duckdns.
- Les fichiers `requirements.txt` dans `notebooks/` proviennent des environnements Google Colab et peuvent contenir des dépendances peu optimisées pour un usage local.
- Le fichier `.env`, exclu du dépôt, contient les variables d'environnement nécessaires (configuration MLFlow, MinIO, alerting).
- Données d'entraînement : `./fetch-data.sh` (Sentiment140 n'est **pas** dans git).
---