Create README.md

README.md

@@ -0,0 +1,83 @@
+---
+language:
+- fr
+license:
+- other
+size_categories:
+- 10K<n<100K
+task_categories:
+- text-classification
+task_ids:
+- text-scoring
+- semantic-similarity-scoring
+---
+
+# stsb_multi_mt_fr_prompt
+## Summary
+
+**stsb_multi_mt_fr_prompt** is a subset of the [**Dataset of French Prompts (DFP)**]().
+It contains **X** rows that can be used for a semantic similarity scoring task.
+The original data (without prompts) comes from the dataset [stsb_multi_mt](https://huggingface.co/datasets/stsb_multi_mt) by May 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
+18 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.
+
+```
+'Déterminer le score de similarité entre les deux phrases suivantes. Phrase 1 : "'+sentence1+'"\n Phrase 2 : "'+sentence2+'"',  
+'Déterminez le score de similarité entre les deux phrases suivantes. Phrase 1 : "'+sentence1+'"\n Phrase 2 : "'+sentence2+'"',  
+'Détermine le score de similarité entre les deux phrases suivantes. Phrase 1 : "'+sentence1+'"\n Phrase 2 : "'+sentence2+'"',  
+'Indiquer le score de similarité entre les deux phrases suivantes. Phrase 1 : "'+sentence1+'"\n Phrase 2 : "'+sentence2+'"',  
+'Indiquez le score de similarité entre les deux phrases suivantes. Phrase 1 : "'+sentence1+'"\n Phrase 2 : "'+sentence2+'"',  
+'Indique le score de similarité entre les deux phrases suivantes. Phrase 1 : "'+sentence1+'"\n Phrase 2 : "'+sentence2+'"',  
+'Donner le score de similarité entre les deux phrases suivantes. Phrase 1 : "'+sentence1+'"\n Phrase 2 : "'+sentence2+'"',  
+'Donnez le score de similarité entre les deux phrases suivantes. Phrase 1 : "'+sentence1+'"\n Phrase 2 : "'+sentence2+'"',  
+'Donne le score de similarité entre les deux phrases suivantes. Phrase 1 : "'+sentence1+'"\n Phrase 2 : "'+sentence2+'"',  
+'Déterminer le score de similarité entre la phrase : "'+sentence1+'"\n et la phrase : "'+sentence2+'"\n Similarité : ',  
+'Déterminez le score de similarité entre la phrase : "'+sentence1+'"\n et la phrase : "'+sentence2+'"\n Similarité : ',  
+'Détermine le score de similarité entre la phrase : "'+sentence1+'"\n et la phrase : "'+sentence2+'"\n Similarité : ',  
+'Indiquer le score de similarité entre la phrase : "'+sentence1+'"\n et la phrase : "'+sentence2+'"\n Similarité : ',  
+'Indiquez le score de similarité entre la phrase : "'+sentence1+'"\n et la phrase : "'+sentence2+'"\n Similarité : ',  
+'Indique le score de similarité entre la phrase : "'+sentence1+'"\n et la phrase : "'+sentence2+'"\n Similarité : ',  
+'Donner le score de similarité entre la phrase : "'+sentence1+'"\n et la phrase : "'+sentence2+'"\n Similarité : ',  
+'Donnez le score de similarité entre la phrase : "'+sentence1+'"\n et la phrase : "'+sentence2+'"\n Similarité : ',  
+'Donne le score de similarité entre la phrase : "'+sentence1+'"\n et la phrase : "'+sentence2+'"\n Similarité : ',  
+```
+
+### Features used in the prompts
+In the prompt list above, `sentence1`, `sentence2` and the `target` have been constructed from:
+```
+stsb = load_dataset('stsb_multi_mt','fr')  
+sentence1 = stsb['train'][i]['sentence1']  
+sentence2 = stsb['train'][i]['sentence2']  
+targets = float(stsb['train'][i]['similarity_score'])/5.0)
+```
+
+
+# Splits
+- train with X samples
+- dev with Y samples
+- test with Z samples
+
+
+# How to use?
+```
+dataset = load_dataset('stsb_multi_mt_fr_prompt') 
+```
+
+# Citation
+## Original data
+> @InProceedings{huggingface:dataset:stsb_multi_mt,  
+title = {Machine translated multilingual STS benchmark dataset.},  
+author={Philip May},  
+year={2021},  
+url={https://github.com/PhilipMay/stsb-multi-mt}  
+}
+
+## This Dataset
+
+
+# License
+https://github.com/PhilipMay/stsb-multi-mt/blob/main/LICENSE