Create README.md

README.md

@@ -0,0 +1,72 @@
+---
+language:
+- fr
+license: 
+- mit
+size_categories:
+- 10K<n<100K
+tags:
+- coreference
+---
+
+# wino_x_fr_prompt_coreference
+## Summary
+
+**wino_x_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 [wino_x](https://huggingface.co/datasets/demelin/wino_x) 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:
+```
+wino_x = load_dataset('demelin/wino_x','lm_en_fr') 
+sentence = wino_x['test'][i]['context_fr']
+option1 = wino_x['test'][i]['option1_fr']
+option2 = wino_x['test'][i]['option2_fr']  
+targets = str(wino_x['test'][i]['answer']).replace("1",wino_x['test'][i]['option1_fr']).replace("2",wino_x['test'][i]['option2_fr'])
+```
+
+
+# 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/wino_x_fr_prompt_coreference")
+```
+
+# Citation
+## Original data
+> @inproceedings{Emelin2021WinoXMW, title={Wino-X: Multilingual Winograd Schemas for Commonsense Reasoning and Coreference Resolution}, author={Denis Emelin and Rico Sennrich}, booktitle={EMNLP}, year={2021} }
+
+
+
+## This Dataset
+
+
+
+## License
+MIT