tfrere commited on
Commit
9bb60ac
·
1 Parent(s): 0821095

update readme

Browse files
Files changed (1) hide show
  1. README.md +9 -90
README.md CHANGED
@@ -1,90 +1,9 @@
1
- # Leaderboard Parser
2
-
3
- Un outil pour extraire automatiquement les données des leaderboards Hugging Face à l'aide d'agents IA.
4
-
5
- ## Structure du projet
6
-
7
- ```
8
- leaderboard-parser/
9
- ├── main.py # Point d'entrée principal
10
- ├── data/ # Données d'entrée et de sortie
11
- │ ├── leaderboards.json # Liste des URLs des leaderboards à traiter
12
- │ └── leaderboard_results.json # Résultats de l'extraction
13
- ├── src/ # Code source principal
14
- │ ├── agent.py # Gestion de l'agent IA
15
- │ ├── browser.py # Gestion du navigateur
16
- │ └── tools.py # Outils utilisés par l'agent
17
- ├── experiments/ # Scripts expérimentaux
18
- ├── pyproject.toml # Configuration Poetry
19
- └── README.md # Documentation
20
- ```
21
-
22
- ## Description
23
-
24
- Ce projet utilise Playwright et smolagents pour naviguer sur les leaderboards Hugging Face et extraire les informations du premier modèle de chaque leaderboard. Les informations extraites incluent :
25
-
26
- - Nom du modèle
27
- - Score
28
- - Position/rang
29
- - Créateur/auteur
30
-
31
- ## Prérequis
32
-
33
- - Python 3.10 ou supérieur
34
- - Poetry (gestionnaire de dépendances)
35
-
36
- ## Installation
37
-
38
- 1. Assurez-vous d'avoir Python 3.10+ installé
39
- 2. Installez Poetry si ce n'est pas déjà fait : `pip install poetry`
40
- 3. Installez les dépendances : `poetry install`
41
-
42
- ## Configuration
43
-
44
- 1. Copiez le fichier `.env.example` vers `.env`
45
- 2. Configurez vos clés API dans le fichier `.env`
46
- 3. Modifiez le fichier `data/leaderboards.json` pour ajouter ou supprimer des URLs de leaderboards
47
-
48
- ## Utilisation
49
-
50
- Pour exécuter le parser sur tous les leaderboards définis dans `data/leaderboards.json` :
51
-
52
- ```bash
53
- poetry run leaderboard-parser
54
- ```
55
-
56
- Ou directement :
57
-
58
- ```bash
59
- poetry run python main.py
60
- ```
61
-
62
- Les résultats seront sauvegardés dans `data/leaderboard_results.json`.
63
-
64
- ## Fonctionnement
65
-
66
- L'outil utilise un agent IA basé sur `smolagents` pour :
67
-
68
- 1. Naviguer vers chaque URL de leaderboard
69
- 2. Analyser la page pour trouver le tableau de classement
70
- 3. Extraire les trois premiers modèles avec leurs scores
71
- 4. Sauvegarder les résultats dans un fichier JSON
72
-
73
- ## Développement
74
-
75
- Pour ajouter un nouvel outil à l'agent, créez une fonction dans `src/tools.py` et décorez-la avec `@tool`.
76
-
77
- Pour modifier les instructions données à l'agent, modifiez la variable `leaderboard_instructions` dans `src/agent.py`.
78
-
79
- ## Expériences
80
-
81
- Le dossier `experiments/` contient des scripts expérimentaux qui ont été utilisés pour développer et tester différentes approches.
82
-
83
- ## Comment ça fonctionne
84
-
85
- 1. Le script charge les URLs des leaderboards depuis `data/leaderboards.json`
86
- 2. Pour chaque URL, il lance un navigateur et utilise un agent IA pour :
87
- - Naviguer vers l'URL du leaderboard
88
- - Analyser la page pour trouver les trois premiers modèles
89
- - Extraire les informations pertinentes
90
- 3. Les résultats sont sauvegardés dans `data/leaderboard_results.json`
 
1
+ ---
2
+ title: minimal-browser-screenshot-experiment
3
+ emoji: 💻
4
+ colorFrom: blue
5
+ colorTo: red
6
+ sdk: docker
7
+ app_file: app/server.py
8
+ pinned: false
9
+ ---