Create README.md

README.md

@@ -0,0 +1,86 @@
+---
+language:
+- fr
+license: mit
+size_categories:
+- 10K<n<100K
+task_categories:
+- text-generation
+---
+
+# piaf_fr_prompt_context_generation_with_question
+## Summary
+
+**piaf_fr_prompt_context_generation_with_question** is a subset of the [**Dataset of French Prompts (DFP)**]().  
+It contains **48,069** rows that can be used for a context-generation (with answer and question)
+task.  
+The original data (without prompts) comes from the dataset [PIAF](https://huggingface.co/datasets/etalab-ia/piaf) and was augmented by questions in SQUAD 2.0 format in the [FrenchQA]( https://huggingface.co/datasets/CATIE-AQ/frenchQA) dataset.
+A list of prompts (see below) was then applied in order to build the input and target columns and thus obtain the same format as the [xP3](https://huggingface.co/datasets/bigscience/xP3) dataset by Muennighoff et al.
+
+
+## Prompts used
+### List
+24 prompts were created for this dataset. The logic applied consists in proposing prompts in the indicative tense, in the form of tutoiement and in the form of vouvoiement.
+
+```
+'Étant donné la question "'+question+'", écrire un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", écris un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", écrivez un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", rédiger un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", rédige un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", rédigez un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", générer un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", génère un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", générez un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", créer un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", crée un texte explicatif.\nTexte : ',  
+'Étant donné la question "'+question+'", créez un texte explicatif.\nTexte : ',  
+'Ecrire un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Ecris un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Ecrivez un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Rédiger un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Rédige un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Rédigez un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Générer un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Génère un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Générez un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Créer un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Crée un texte comme contexte à la question "'+question+'" \nTexte : ',  
+'Créez un texte comme contexte à la question "'+question+'" \nTexte : '  
+```
+
+# Splits
+- train with 48,069 samples
+- no valid and test splits in the original data
+
+
+# How to use?
+```
+from datasets import load_dataset
+dataset = load_dataset("CATIE-AQ/piaf_fr_prompt_context_generation_with_question")
+```
+
+
+# Citation
+## Original data
+> @InProceedings{keraron-EtAl:2020:LREC,
+  author    = {Keraron, Rachel  and  Lancrenon, Guillaume  and  Bras, Mathilde  and  Allary, Frédéric  and  Moyse, Gilles  and  Scialom, Thomas  and  Soriano-Morales, Edmundo-Pavel  and  Staiano, Jacopo},
+  title     = {Project PIAF: Building a Native French Question-Answering Dataset},
+  booktitle      = {Proceedings of The 12th Language Resources and Evaluation Conference},
+  month          = {May},
+  year           = {2020},
+  address        = {Marseille, France},
+  publisher      = {European Language Resources Association},
+  pages     = {5483--5492},
+  url       = {https://www.aclweb.org/anthology/2020.lrec-1.673}
+}
+
+
+
+
+## This Dataset
+
+
+
+## License
+MIT