Create README.md

README.md

@@ -0,0 +1,74 @@
+---
+task_categories:
+- question-answering
+language:
+- fr
+size_categories:
+- 100K<n<1M
+---
+
+# Information concernant le jeu de données 
+Jeu de données concaténant tous les jeux de données de QA avec contexte disponible en français et en open-source.  
+A ces jeux de données ont été ajouté une version augmenté de ces derniers (même contexte mais avec des questions différentes afin de créer des données au format SQuADv2).  
+Au total il y a **221 348** données d'entraînement, **910** données de validation et **6 376** données de test (les 3 188 premières lignes correspondent au format SQuADv2, les 3 188 au format SQuADv2). 
+
+
+##  Usage
+```
+from datasets import load_dataset
+dataset = load_dataset("CATIE-AQ/frenchQA",sep=";")
+```
+```
+dataset
+DatasetDict({
+    train: Dataset({
+        features: ['context', 'question', 'answer', 'answer_start', 'dataset'],
+        num_rows: 221348
+    })
+    test: Dataset({
+        features: ['context', 'question', 'answer', 'answer_start', 'dataset'],
+        num_rows: 3188
+    })
+    validation: Dataset({
+        features: ['context', 'question', 'answer', 'answer_start', 'dataset'],
+        num_rows: 910
+    })
+})
+```
+
+```
+dataset_train = dataset['train'].to_pandas()
+dataset_train.head()
+
+   	context 	                                        question 	                                        answer 	                    answer_start 	dataset
+0 	Beyoncé Giselle Knowles-Carter (/ biːˈjɒnseɪ /... 	Quand Beyonce a-t-elle commencé à devenir popu... 	à la fin des années 1990 	269 	        pragnakalp/squad_v2_french_translated
+1 	Beyoncé Giselle Knowles-Carter (/ biːˈjɒnseɪ /... 	Quand Beyonce a-t-elle quitté Destiny's Child ... 	2003 	                    549 	        pragnakalp/squad_v2_french_translated
+2 	Beyoncé Giselle Knowles-Carter (/ biːˈjɒnseɪ /... 	Qui a dirigé le groupe Destiny's Child ? 	        Mathew Knowles 	            376 	        pragnakalp/squad_v2_french_translated
+3 	Beyoncé Giselle Knowles-Carter (/ biːˈjɒnseɪ /... 	Quand Beyoncé a-t-elle sorti Dangerously in Lo... 	2003 	                    549 	        pragnakalp/squad_v2_french_translated
+4 	Beyoncé Giselle Knowles-Carter (/ biːˈjɒnseɪ /... 	Combien de Grammy Awards Beyoncé a-t-elle gagn... 	cinq 	                    629 	        pragnakalp/squad_v2_french_translated
+```
+
+## Colonnes
+- la colonne `context` contient le contexte
+- la colonne `question` contient la question
+- la colonne `answer` contient la réponse (a été remplacé par `sans_réponse` pour les lignes au format SQuAD v2)
+- la colonne `answer_start` contient la position du début de la réponse dans le contexte ( a été remplacé par `-1` pour les lignes au format SQuAD v2)
+- la colonne `dataset` permet de connaître le jeu de données d'origine de la ligne (si on souhaite appliquer des filtres dessus, les lignes au format SQuAD v2 sont indiquées avec le suffixe `_v2` dans le nom du jeu de données)
+
+## Split
+- `train` correspond à la concaténation du jeu de données d'entraînement de `pragnakalp/squad_v2_french_translated` + `FQuADv1.0` + `lincoln/newsquadfr` + `PIAFv1.2` + la version augmentée de chaque jeu de données au format SQuADv2 (aucun shuffle n'a été effectué)
+- `validation` correspond à la concaténation du jeu de données de validation de newsquadfr + ce même jeu de donnée augmenté au format SQuAD v2 (= newsquadfr_v2)  (aucun shuffle n'a été effectué)
+- `test` correspond à l'échantillon de validation de FQuAD (le jeu de données de test de FQuAD n'étant pas dispo en open-source, le jeu de validation est devenu celui sur lequel les différents modèles se comparent) + ce même jeu de donnée augmenté au format SQuAD v2 (= fquad_v2)  (aucun shuffle n'a été effectué)
+
+## Datasets
+
+| Dataset     | Format      | Train split | Dev split   | Test split  |
+| ----------- | ----------- | ----------- | ----------- | ----------- |
+| [piaf](https://www.data.gouv.fr/en/datasets/piaf-le-dataset-francophone-de-questions-reponses/)| SQuAD v1    | 9 224 Q & A  | X  | X  |  
+| piaf_v2| SQuAD v2    | 9 224 Q & A  | X  | X  |         
+| [fquad](https://fquad.illuin.tech/)| SQuAD v1    | 20 731 Q & A | 3 188 Q & A  (n'est pas utilisé pour entraîner car sert de jeu de données de test) | 2 189 Q & A (non disponible librement)|         
+| fquad_v2 | SQuAD v2    | 20 731 Q & A | X | X |         
+| [lincoln/newsquadfr](https://huggingface.co/datasets/lincoln/newsquadfr) | SQuAD v1    | 1 650 Q & A  | 455 Q & A | X |           
+| lincoln/newsquadfr_v2 | SQuAD v2    | 1 650 Q & A  | 455 Q & A | X |         
+| [pragnakalp/squad_v2_french_translated](https://huggingface.co/datasets/pragnakalp/squad_v2_french_translated)| SQuAD v2    | 79 069 Q & A  | X  | X  |         
+| pragnakalp/squad_v2_french_translated_v2| SQuAD v2    | 79 069 Q & A  | X  | X  |