Create README.md

README.md

@@ -0,0 +1,87 @@
+---
+language:
+- fr
+license: 
+- cc-by-4.0
+size_categories:
+- 10K<n<100K
+tags:
+- coreference
+---
+
+# xwinograd_fr_prompt_coreference
+## Summary
+
+**xwinograd_fr_prompt_coreference** is a subset of the [**Dataset of French Prompts (DFP)**]().
+It contains **X** rows that can be used for a coreference task.
+The original data (without prompts) comes from the dataset [xwinograd](https://huggingface.co/datasets/Muennighoff/xwinograd) by Muennighoff. where only the French part has been kept.
+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
+10 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.
+
+```
+'"'+sentence+'"\nRemplacer le "_" dans la phrase ci-dessus par la bonne option :\n- "'+option1+'"\n- "'+option2+'"',  
+'"'+sentence+'"\nRemplace le "_" dans la phrase ci-dessus par la bonne option :\n- "'+option1+'"\n- "'+option2+'"',  
+'"'+sentence+'"\nRemplacez le "_" dans la phrase ci-dessus par la bonne option :\n- "'+option1+'"\n- "'+option2+'"',  
+'"'+sentence+'" Dans la phrase précédente, "_" fait-il référence à "'+option1+'" ou "'+option2+'" ?',  
+'"'+sentence+'" À quoi le "_" dans la phrase ci-dessus fait-il référence ? "'+option1+'" ou "'+option2+'" ?',  
+'"'+sentence+'" Le "_" dans la phrase ci-dessous fait référence à "'+option1+'"\n- "'+option2+'" ?',  
+'Remplisser le "_" de la phrase suivante : "'+sentence+ '"\nChoix :\n- "'+option1+'"\n- "'+option2+'"\nRéponse :',  
+'Remplis le "_" de la phrase suivante : "'+sentence+ '"\nChoix :\n- "'+option1+'"\n- "'+option2+'"\nRéponse :',  
+'Remplissez le "_" de la phrase suivante : "'+sentence+ '"\nChoix :\n- "'+option1+'"\n- "'+option2+'"\nRéponse :',  
+'Dans la phrase ci-dessous, le "_" renvoie-t-il à "'+option1+'" ou "'+option2+'" ? : '+sentence,
+```
+
+### Features used in the prompts
+In the prompt list above, `option1`, `option2`, `sentence` and `targets` have been constructed from:
+```
+xwinograd = load_dataset('Muennighoff/xwinograd','fr')
+sentence = xwinograd['test'][i]['sentence']
+option1 = xwinograd['test'][i]['option1']
+option2 = xwinograd['test'][i]['option2']
+targets = str(xwinograd['test'][i]['answer']).replace("1",xwinograd['test'][i]['option1']).replace("2",xwinograd['test'][i]['option2'])
+```
+
+
+# Splits
+- train with X samples
+- dev with Y samples
+- test with Z samples
+
+
+# How to use?
+```
+from datasets import load_dataset
+dataset = load_dataset("CATIE-AQ/xwinograd_fr_prompt_coreference")
+```
+
+# Citation
+## Original data
+> @misc{muennighoff2022crosslingual,
+      title={Crosslingual Generalization through Multitask Finetuning}, 
+      author={Niklas Muennighoff and Thomas Wang and Lintang Sutawika and Adam Roberts and Stella Biderman and Teven Le Scao and M Saiful Bari and Sheng Shen and Zheng-Xin Yong and Hailey Schoelkopf and Xiangru Tang and Dragomir Radev and Alham Fikri Aji and Khalid Almubarak and Samuel Albanie and Zaid Alyafeai and Albert Webson and Edward Raff and Colin Raffel},
+      year={2022},
+      eprint={2211.01786},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+> @misc{tikhonov2021heads,
+    title={It's All in the Heads: Using Attention Heads as a Baseline for Cross-Lingual Transfer in Commonsense Reasoning},
+    author={Alexey Tikhonov and Max Ryabinin},
+    year={2021},
+    eprint={2106.12066},
+    archivePrefix={arXiv},
+    primaryClass={cs.CL}
+}
+
+
+
+## This Dataset
+
+
+
+## License
+ [cc-by-4.0](https://creativecommons.org/licenses/by/4.0/deed.en)