Skip to content

Commit e68cf59

Browse files
committed
doc: update main README
1 parent 04c490b commit e68cf59

File tree

3 files changed

+25
-39
lines changed

3 files changed

+25
-39
lines changed

README.md

Lines changed: 25 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Le projet est structuré en plusieurs sous-projets :
1818
- **Policy analysis** (dans `policy_analysis/`) : pipeline d'extraction et d'analyse de politiques de sobriété et de leurs impacts dont les résultats ont vocation à être inclus dans le RAG.
1919
- **ChatSufficiency** (dans `rag_system/`) : chatbot destiné aux experts des politiques publiques, branchés en RAG sur la library et les résultats de la policy analysis.
2020

21-
Voici un schéma d'architecture du projet (à mettre à jour) :
21+
Voici un schéma d'architecture du projet :
2222
![Schéma du projet](assets/architecture.png)
2323

2424

@@ -55,55 +55,41 @@ Il a donc été décidé d'en sortir et de réimplémenter les fonctionnalités
5555

5656
[README ChatSufficiency](rag_system/README.md)
5757

58-
## Ressources cloud
59-
![Schéma des ressources cloud](assets/cloud_resources.png)
6058

59+
## Quick Start
60+
Chaque dossier est un projet indépendant, mais voici les dépendances communes à installer.
6161

62-
## Roadmap
63-
64-
Voici dans les grosses mailles les étapes prévues:
65-
66-
- [ ] Nettoyage du repo et de la base de données postgres
67-
- [ ] Refactoring pour mieux isoler les sous-projets
68-
- [ ] Web app moteur de recherche par mot-clés sur les abstracts des articles de la library
69-
- [ ] Refaire tourner l'extraction du full-text pour les articles open access et essayer de l'obtenir par les abonnements du WSL pour les autres
70-
- [ ] Adaptation du moteur de recherche au full text
71-
- [ ] Chunking et embedding pour ingestion en base vectorielle
72-
- [ ] Adaptation du moteur de recherche à la recherche sémantique
73-
- [ ] V1 du chatbot : génération par LLM + adaptation de la web app
74-
- [ ] Finalisation du pipeline de policy analysis
75-
- [ ] Intégration de la policy analysis au chatbot
76-
- [ ] V2 du chatbot
7762

78-
79-
## 🚀 Quick Start
80-
81-
### 1. Installer les dépendances `uv` et `pip`
63+
Installer uv :
8264

8365
```bash
84-
# macOS et Linux
8566
curl -LsSf https://astral.sh/uv/install.sh | sh
86-
87-
# Windows
88-
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
89-
90-
# Alternative : via pip
91-
pip install uv
9267
```
9368

94-
Plus d'informations : [documentation officielle de uv](https://astral.sh/uv)
95-
69+
Installer pre-commit avec uv (pas obligatoire si vous avez déjà pre-commit installé) :
9670

97-
### 2. Lancer les precommit-hooks localement
98-
99-
[Installer les precommit](https://pre-commit.com/)
71+
```
72+
uv tool install pre-commit --with pre-commit-uv
73+
pre-commit --version
74+
```
10075

101-
pre-commit run --all-files
76+
Lancer les pre-commit hooks manuellement :
77+
```
78+
pre-commit run --all-files
79+
```
10280

103-
### 3. Utiliser Tox pour tester votre code
10481

105-
tox -vv
82+
## Roadmap
10683

84+
Voici dans les grosses mailles les étapes prévues:
10785

108-
> [!IMPORTANT]
109-
> Projet en développement actif, pas de garantie de fonctionnement, notamment pour les tests.
86+
- [x] Nettoyage du repo et de la base de données postgres
87+
- [x] Refactoring pour mieux isoler les sous-projets
88+
- [x] Recréer la library
89+
- [x] Chunking et embedding pour ingestion en base vectorielle
90+
- [x] V0 du chatbot sans policy analysis
91+
- [ ] Finalisation du pipeline de policy analysis et application à un petit échantillon de la library
92+
- [ ] V1 du chatbot avec intégration de la policy analysis
93+
- [ ] V2 de la library : extraction markdown et chunking plus fin
94+
- [ ] Application du pipeline de policy analysis à toute la library, ou une portion conséquente (besoin de ressources de calcul importantes -> Jean Zay)
95+
- [ ] V2 du chatbot

assets/architecture.png

-154 KB
Loading

assets/cloud_resources.png

-200 KB
Binary file not shown.

0 commit comments

Comments
 (0)