Create README.md

README.md

@@ -0,0 +1,90 @@
+---
+language:
+- fr
+license: other
+size_categories:
+- 10K<n<100K
+task_categories:
+- text-classification
+---
+
+# amazon_review_multi_fr_prompt_classes_classification 
+## Summary
+
+**amazon_review_multi_fr_prompt_classes_classification** is a subset of the [**Dataset of French Prompts (DFP)**]().  
+It contains **48,069** rows that can be used for a text classification task.  
+The original data (without prompts) comes from the dataset [amazon_reviews_multi](https://huggingface.co/datasets/amazon_reviews_multi) by Keung et al. where only the French split 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
+21 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.
+
+```
+'Le texte suivant parle-t-il de "'+classes+'" ?\n Texte : '+text,
+'Le texte suivant concerne-t-il "'+classes+'" ?\n Texte : '+text,
+'Le texte suivant évoque-t-il "'+classes+'" ?\n Texte : '+text,
+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
+```
+
+### Features used in the prompts
+In the prompt list above, `text` and `targets` have been constructed from:
+```
+arm = load_dataset('amazon_reviews_multi', 'fr')
+text = arm['train']['review_body'][i]
+targets = arm['train']['product_category'][i].replace('personal_care_appliances','appareils_de_soins_personnels').replace('beauty','beauté').replace('lawn_and_garden','pelouse_et_jardin').replace('digital_ebook_purchase','livres_numériques').replace('musical_instruments','instruments').replace('watch','montre').replace('other','autre').replace('jewelry','bijou').replace('automotive','automobile').replace('apparel','vêtement').replace('video_games','jeux_vidéos').replace('toy','jeux').replace('luggage', 'bagages').replace('pet_products', 'produits_animaux').replace('electronics','électroniques').replace('office_product','produit_bureau').replace('drugstore','pharmacie').replace('camera','appareil_photo').replace('home','maison').replace('furniture','meubles').replace('book','livre').replace('wireless','sans_fil').replace('grocery','épicerie').replace('industrial_supplies','fournitures_industrielles').replace('kitchen','cuisine').replace('baby_product','produit_bébé').replace('shoes','chaussures').replace('home_improvement','amélioration_de_la_maison')
+```
+
+
+
+# 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/amazon_review_multi_fr_prompt_text_generation")
+```
+
+# Citation
+## Original data
+> @inproceedings{marc_reviews,
+    title={The Multilingual Amazon Reviews Corpus},
+    author={Keung, Phillip and Lu, Yichao and Szarvas, György and Smith, Noah A.},
+    booktitle={Proceedings of the 2020 Conference on Empirical Methods in Natural Language Processing},
+    year={2020}
+}
+
+
+
+
+## This Dataset
+
+
+
+## License
+Amazon has licensed his dataset under its own agreement for non-commercial research usage only. This licence is quite restrictive preventing use anywhere a fee is received including paid for internships etc. A copy of the agreement can be found at the dataset webpage here: https://docs.opendata.aws/amazon-reviews-ml/license.txt
+
+By accessing the Multilingual Amazon Reviews Corpus ("Reviews Corpus"), you agree that the Reviews Corpus is an Amazon Service subject to the Amazon.com Conditions of Use and you agree to be bound by them, with the following additional conditions:
+
+In addition to the license rights granted under the Conditions of Use, Amazon or its content providers grant you a limited, non-exclusive, non-transferable, non-sublicensable, revocable license to access and use the Reviews Corpus for purposes of academic research. You may not resell, republish, or make any commercial use of the Reviews Corpus or its contents, including use of the Reviews Corpus for commercial research, such as research related to a funding or consultancy contract, internship, or other relationship in which the results are provided for a fee or delivered to a for-profit organization. You may not (a) link or associate content in the Reviews Corpus with any personal information (including Amazon customer accounts), or (b) attempt to determine the identity of the author of any content in the Reviews Corpus. If you violate any of the foregoing conditions, your license to access and use the Reviews Corpus will automatically terminate without prejudice to any of the other rights or remedies Amazon may have.