Update README.md

README.md

@@ -5,12 +5,14 @@ language:
 - fr
 size_categories:
 - 100K<n<1M
+license: cc-by-4.0
 ---
 
-# 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). 
+# Dataset information 
+Dataset concatenating all QA datasets with context available in French and open-source.  
+In addition, an augmented version of these datasets has been added (same context but different questions to create data in SQuADv2 format).  
+In total, there are 221,348 training data, **910** validation data and 6,376 test data (the first 3,188 rows correspond to SQuADv2 format, the remaining 3,188 to SQuADv2 format). 
+In practice, due to the restrictive license for the FQUAD 1.0 dataset, we can only share **179,886** rows of the 221,348 training data and not the test dataset.
 
 
 ##  Usage
@@ -23,11 +25,7 @@ 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
+        num_rows: 179886
     })
     validation: Dataset({
         features: ['context', 'question', 'answer', 'answer_start', 'dataset'],
@@ -48,27 +46,61 @@ dataset_train.head()
 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)
+## Columns
+- the `context` column contains the context
+- the `question` column contains the question
+- the `answer` column contains the answer (has been replaced by `no_answer` for rows in SQuAD v2 format)
+- the `answer_start` column contains the start position of the answer in the context (has been replaced by `-1` for rows in SQuAD v2 format)
+- the `dataset` column identifies the row's original dataset (if you wish to apply filters to it, rows in SQuAD v2 format are indicated with the suffix `_v2` in the dataset name)
 
 ## 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é)
+- train` corresponds to the concatenation of the training dataset from `pragnakalp/squad_v2_english_translated` + `lincoln/newsquadfr` + `PIAFv1.2` + the augmented version of each dataset in SQuADv2 format (no shuffle has been performed)
+- `validation` corresponds to the concatenation of the newsquadfr validation dataset + this same dataset expanded in SQuAD v2 format (= newsquadfr_v2) (no shuffle performed)
 
 ## 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 | 3 188 Q & A  (n'est pas utilisé pour entraîner car sert de jeu de données de test) | 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  |
+| Dataset     | Format      | Train split | Dev split   | Test split  | Available in frenchQA |
+| ----------- | ----------- | ----------- | ----------- | ----------- | ------------------------ |
+| [piaf](https://www.data.gouv.fr/en/datasets/piaf-le-dataset-francophone-de-questions-reponses/)| SQuAD 1.0    | 9 224 Q & A  | X  | X  |  Yes |
+| piaf_v2| SQuAD 2.0    | 9 224 Q & A  | X  | X  | Yes |        
+| [fquad](https://fquad.illuin.tech/)| SQuAD 1.0    | 20 731 Q & A | 3 188 Q & A  (is not used for training, but as a test dataset) | 2 189 Q & A (not freely available)| No due to the license |        
+| fquad_v2 | SQuAD 2.0    | 20 731 Q & A | 3 188 Q & A  (is not used for training, but as a test dataset) | X | No due to the license |         
+| [lincoln/newsquadfr](https://huggingface.co/datasets/lincoln/newsquadfr) | SQuAD 1.0    | 1 650 Q & A  | 455 Q & A | X |   Yes |          
+| lincoln/newsquadfr_v2 | SQuAD 2.0   | 1 650 Q & A  | 455 Q & A | X |  Yes |         
+| [pragnakalp/squad_v2_french_translated](https://huggingface.co/datasets/pragnakalp/squad_v2_french_translated)| SQuAD 2.0    | 79 069 Q & A  | X  | X  |  Yes |         
+| pragnakalp/squad_v2_french_translated_v2| SQuAD 2.0    | 79 069 Q & A  | X  | X  |  Yes |
+
+## Statistics
+
+The question type distribution is as follows:
+
+| Type of question | Frequency in percent |
+| -----------      | ----------- |
+|What (que)        |55.02|
+|Who (qui)         |15.96|
+|How much (combien)|7.92|
+|When (quand)      |6.90|
+|Where (où)        |3.15|
+|How (comment)     |3.76|
+|What (quoi)       |2.60|
+|Why (pourquoi)    |1.25|
+|Other             |3.44|
+
+The number of questions containing a negation, e.g. "What was the name of Chopin's first music teacher who was not an amateur musician?", is estimated at 3.55% of the total questions.
+
+
+For information, the distribution of the complete dataset (containing FQUAD 1.0 and FQUAD 1.0 data in SQUAD 2.0 format) is as follows:
+
+| Type of question | Frequency in percent |
+| -----------      | ----------- |
+|What (que)        |55.12|
+|Who (qui)         |16.24|
+|How much (combien)|7.56|
+|When (quand)      |6.85|
+|Where (où)        |3.98|
+|How (comment)     |3.76|
+|What (quoi)       |2.94|
+|Why (pourquoi)    |1.41|
+|Other             |2.14|
+
+The number of questions containing a negation, e.g. "What was the name of Chopin's first music teacher who was not an amateur musician?", is estimated at 3.07% of the total questions.