Upload folder using huggingface_hub

README.md

@@ -1,3 +1,66 @@
----
-license: mit
----
+# French KID (Key Information Document) Dataset
+
+Ce dataset contient des images de documents financiers (KIDs - Key Information Documents) avec des questions et réponses générées par le modèle Gemini 2.0 Flash Lite.
+
+## Contenu du Dataset
+
+Ce dataset contient :
+- Des images de pages de documents financiers (principalement des KIDs)
+- Des questions financières pertinentes sur le contenu des images
+- Les réponses à ces questions
+- La langue du document (en code ISO à 2 lettres)
+- Le numéro de page
+
+## Structure
+
+```
+dataset/
+│
+├── images/          # Répertoire contenant toutes les images
+│   ├── kid-page-xxx.png
+│   └── ...
+│
+├── train.json       # Données d'entraînement (80%)
+├── validation.json  # Données de validation (10%)
+└── test.json        # Données de test (10%)
+```
+
+## Format des Données
+
+Chaque entrée dans les fichiers JSON contient :
+
+```json
+{
+  "image": "images/kid-page-xxx.png",
+  "query": "Question financière sur le contenu de l'image",
+  "answer": "Réponse à la question basée sur l'image",
+  "langue": "fr",
+  "page": "1"
+}
+```
+
+## Utilisation
+
+Ce dataset est conçu pour l'entraînement de modèles de vision-langage (VLM) spécialisés dans l'analyse de documents financiers.
+
+### Exemple de chargement avec Hugging Face datasets
+
+```python
+from datasets import load_dataset
+
+# Charger le dataset
+dataset = load_dataset("Marsouuu/french-kid")
+
+# Accéder aux différentes parties
+train_data = dataset["train"]
+validation_data = dataset["validation"]
+test_data = dataset["test"]
+```
+
+## Création
+
+Le dataset a été créé en utilisant l'API Gemini de Google (modèle gemini-2.0-flash-lite) pour analyser les images et générer des questions et réponses pertinentes.
+
+## Licence
+
+[Préciser la licence ici] 

card-dataset.md

@@ -0,0 +1,137 @@
+---
+language:
+- fr
+- en
+license: cc-by-sa-4.0
+multilinguality: multilingual
+pretty_name: French KID Dataset
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+tags:
+- finance
+- document-understanding
+- question-answering
+- multimodal
+- vision-language
+task_categories:
+- question-answering
+- document-understanding
+task_ids:
+- document-qa
+- text-qa
+- visual-question-answering
+---
+
+# French KID Dataset
+
+## Description du Dataset
+
+Le French KID Dataset est une collection d'images de documents financiers (Key Information Documents - KIDs) accompagnées de questions et réponses pertinentes générées par l'API Gemini. Ce dataset a été conçu pour entraîner des modèles de vision-langage (VLM) à comprendre et à répondre à des questions précises sur des documents financiers.
+
+### Contenu du Dataset
+
+- **Images** : Pages de documents KID au format PNG
+- **Questions** : Questions financières spécifiques sur le contenu des images
+- **Réponses** : Réponses précises aux questions posées
+- **Langue** : Code ISO à 2 lettres (fr, en, etc.) indiquant la langue du document
+- **Page** : Numéro de page du document
+
+## Statistiques du Dataset
+
+| Split       | Nombre d'exemples |
+|-------------|-------------------|
+| Train       | ~4000             |
+| Validation  | ~500              |
+| Test        | ~500              |
+| **Total**   | ~5000             |
+
+## Format des Données
+
+Chaque entrée du dataset contient les champs suivants :
+
+```json
+{
+  "image": "images/kid-page-xxx.png",
+  "query": "Question financière sur le contenu de l'image",
+  "answer": "Réponse à la question basée sur l'image",
+  "langue": "fr",
+  "page": "1"
+}
+```
+
+## Processus de Création
+
+Le dataset a été créé selon la procédure suivante :
+
+1. Collecte d'images de pages de documents KID
+2. Utilisation de l'API Gemini (modèle gemini-2.0-flash-lite) pour :
+   - Analyser chaque image
+   - Générer une question financière pertinente basée sur le contenu visible
+   - Fournir la réponse à cette question
+   - Identifier la langue du document
+   - Extraire le numéro de page s'il est visible
+
+3. Division des données en ensembles d'entraînement (80%), de validation (10%) et de test (10%)
+
+## Cas d'Utilisation
+
+Ce dataset est particulièrement utile pour :
+
+- Entraîner des modèles de vision-langage à comprendre des documents financiers
+- Développer des assistants IA spécialisés dans l'analyse de documents KID
+- Rechercher des informations spécifiques dans des documents financiers
+- Extraire automatiquement des informations clés de documents réglementaires
+
+## Exemple de Chargement
+
+```python
+from datasets import load_dataset
+import matplotlib.pyplot as plt
+import matplotlib.image as mpimg
+from pathlib import Path
+
+# Charger le dataset
+dataset = load_dataset("Marsouuu/french-kid")
+
+# Accéder à un exemple
+example = dataset["train"][0]
+
+# Afficher l'image
+img_path = Path(example["image"])
+img = mpimg.imread(img_path)
+plt.imshow(img)
+plt.axis('off')
+plt.show()
+
+# Afficher la question et la réponse
+print(f"Question: {example['query']}")
+print(f"Réponse: {example['answer']}")
+print(f"Langue: {example['langue']}")
+print(f"Page: {example['page']}")
+```
+
+## Limitations
+
+- Les questions et réponses sont générées par un modèle IA et peuvent contenir des erreurs
+- Le dataset se concentre principalement sur les documents KID et peut ne pas être représentatif d'autres types de documents financiers
+- La qualité des réponses dépend de la lisibilité des images source
+
+## Citation
+
+Si vous utilisez ce dataset dans votre recherche, veuillez le citer comme suit :
+
+```
+@dataset{french_kid_2024,
+  author    = {Martial Roberge},
+  title     = {French KID Dataset},
+  year      = {2024},
+  publisher = {Hugging Face},
+  howpublished = {\url{https://huggingface.co/datasets/Marsouuu/french-kid}}
+}
+```
+
+## Remerciements
+
+Nous remercions Google pour l'accès à l'API Gemini qui a permis la création de ce dataset.