Create README.md

README.md

@@ -0,0 +1,100 @@
+---
+language:
+- fr
+license: 
+- unknown
+size_categories:
+- 10K<n<100K
+task_categories:
+- text-classification
+tags:
+- intent
+---
+
+# mtop_domain_intent_fr_prompt_intent_classification
+## Summary
+
+**mtop_domain_intent_fr_prompt_intent_classification** is a subset of the [**Dataset of French Prompts (DFP)**]().
+It contains **X** rows that can be used for an intent text classification task.
+The original data (without prompts) comes from the dataset [mtop_domain](https://huggingface.co/datasets/mteb/mtop_domain) Haoran Li et al. 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
+30 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.
+
+```
+text+'\n Étant donné la liste de catégories suivante : "'+classes+'" à quelle catégorie appartient le texte ?',
+text+'\n Étant donné la liste de classes suivante : "'+classes+'" à quelle classe appartient le texte ?',
+'Étant donné une liste de catégories : "'+classes+'" à quelle catégorie appartient le texte suivant ?\n Texte : '+text,
+'Étant donné une liste de classes : "'+classes+'" à quelle classe appartient le texte suivant ?\n Texte : '+text,
+'Étant donné un choix de catégories : "'+classes+'", le texte fait référence à laquelle ?\n Texte : '+text,
+'Étant donné un choix de classe : "'+classes+'", le texte fait référence à laquelle ?\n Texte : '+text,
+'Choisir une catégorie pour le texte suivant. Les options sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Choisir une catégorie pour le texte suivant. Les possibilités sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Choisir une catégorie pour le texte suivant. Les choix sont les suivants : "'+classes+'"\n Texte : '+text,
+'Choisir une classe pour le texte suivant. Les options sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Choisir une classe pour le texte suivant. Les possibilités sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Choisir une classe pour le texte suivant. Les choix sont les suivants : "'+classes+'"\n Texte : '+text,
+'Sélectionner une catégorie pour le texte suivant. Les options sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Sélectionner une catégorie pour le texte suivant. Les possibilités sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Sélectionner une catégorie pour le texte suivant. Les choix sont les suivants : "'+classes+'"\n Texte : '+text,
+'Sélectionner une classe pour le texte suivant. Les options sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Sélectionner une classe pour le texte suivant. Les possibilités sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Sélectionner une classe pour le texte suivant. Les choix sont les suivants : "'+classes+'"\n Texte : '+text,
+'Parmi la liste de catégories suivantes : "'+classes+'",\n indiquer celle présente dans le texte : '+text,
+'Parmi la liste de classes suivantes : "'+classes+'",\n indiquer celle présente dans le texte : '+text,
+"""Parmi la liste d'intentions suivantes :  " """+classes+""" ",\n indiquer celle présente dans le texte : """+text,
+text+"""\n Étant donné la liste d'intentions suivante : " """+classes+""" ", à quelle intention appartient le texte ?""",
+"""Étant donné une liste d'intentions : " """+classes+""" ", à quelle intention appartient le texte suivant ?\n Texte : """+text,
+"""Étant donné un choix d'intentions : " """+classes+""" ", le texte fait référence à laquelle ?""",
+'Choisir une intention pour le texte suivant. Les options sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Choisir une intention pour le texte suivant. Les possibilités sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Choisir une intention pour le texte suivant. Les choix sont les suivants : "'+classes+'"\n Texte : '+text,
+'Sélectionner une intention pour le texte suivant. Les options sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Sélectionner une intention pour le texte suivant. Les possibilités sont les suivantes : "'+classes+'"\n Texte : '+text,
+'Sélectionner une intention pour le texte suivant. Les choix sont les suivants : "'+classes+'"\n Texte : '+text
+```
+
+### Features used in the prompts
+In the prompt list above, `classes`, `text` and `targets` have been constructed from:
+```
+mtop = load_dataset('mteb/mtop_domain','fr')
+classes = 'rappel, actualités, recettes, minuterie, appel, météo, alarme, événement, musique, personne, message'
+text = mtop['train']['text'][i]
+targets = mtop['train']['label_text'][i].replace('reminder','rappel').replace('news','actualités').replace('recipes','recettes').replace('timer','minuterie').replace('calling','appel').replace('weather','météo').replace('alarm','alarme').replace('event','événement').replace('music','musique').replace('people','personne').replace('messaging','message')
+```
+
+
+
+# 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/mtop_domain_intent_fr_prompt_intent_classification")
+```
+
+# Citation
+## Original data
+> @misc{li2021mtop,
+      title={MTOP: A Comprehensive Multilingual Task-Oriented Semantic Parsing Benchmark}, 
+      author={Haoran Li and Abhinav Arora and Shuohui Chen and Anchit Gupta and Sonal Gupta and Yashar Mehdad},
+      year={2021},
+      eprint={2008.09335},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+
+
+## This Dataset
+
+
+
+## License
+Unknown