Create README.md

README.md

@@ -0,0 +1,101 @@
+---
+language:
+- fr
+license: 
+- other
+size_categories:
+- 10K<n<100K
+task_categories:
+- text-classification
+tags:
+- stars-classification
+---
+
+# amazon_review_multi_fr_prompt_stars_classification
+## Summary
+
+**amazon_review_multi_fr_prompt_stars_classification** is a subset of the [**Dataset of French Prompts (DFP)**]().
+It contains **X** rows that can be used for a stars-classification sentiment analysis 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 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
+28 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.
+
+```
+'Commentaire : "'+review+'" Le commentaire est-il positif ou négatif ?',  
+"""Avis : " """+review+""" " L'avis est-il positif ou négatif ?""",  
+'Critique : "'+review+'" La critique est-elle positive ou négative ?',  
+"""Evaluation : " """+review+""" " L'évaluation est-elle positive ou négative ?""",  
+'Ce commentaire sur le produit est-il positif ou négatif ? \nCommentaire : "'+review+'"\nRéponse :',  
+'Cet avis sur le produit est-il positif ou négatif ? \nAvis : "'+review+'"\nRéponse :',  
+'Cette critique sur le produit est-elle positive ou négative ? \nCritique : "'+review+'"\nRéponse :',  
+'Cette évaluation sur le produit est-elle positive ou négative ? \nEvaluation : "'+review+'"\nRéponse :',  
+'Commentaire : "'+review+'"\n Ce commentaire sur le produit exprime-t-il un sentiment négatif ou positif ?',  
+'Avis : "'+review+'"\n Cet avis sur le produit exprime-t-il un sentiment négatif ou positif ?',  
+'Critique : "'+review+'"\n Cette critique sur le produit exprime-t-il un sentiment négatif ou positif ?',  
+'Evaluation : "'+review+'"\n Cette évaluation sur le produit exprime-t-il un sentiment négatif ou positif ?',  
+'Ce commentaire sur le produit a-t-il un ton négatif ou positif ? \n Commentaire : "'+review+'"\n Réponse :',   
+'Cet avis sur le produit a-t-il un ton négatif ou positif ? \n Avis : "'+review+'"\n Réponse :',   
+'Cette critique sur le produit a-t-il un ton négatif ou positif ? \n Evaluation : "'+review+'"\n Réponse :',   
+'Cet évaluation sur le produit a-t-il un ton négatif ou positif ? \n Avis : "'+review+'"\n Réponse :',   
+"""Voici un commentaire laissé par un client sur un produit. Diriez-vous qu'il est négatif ou positif ? \nCommentaire : """+review,  
+"""Voici un avis laissé par un client sur un produit. Diriez-vous qu'il est négatif ou positif ? \nAvis : """+review,  
+"""Voici une critique laissée par un client sur un produit. Diriez-vous qu'elle est négative ou positive ? \nCritique : """+review,  
+"""Voici une évaluation laissée par un client sur un produit. Diriez-vous qu'elle est négative ou positive ? \nEvaluation : """+review,  
+'Commentaire du produit : "'+review+'" Ce commentaire dépeint le produit sous un angle négatif ou positif ?',  
+'Avis du produit : "'+review+'" Cet avis dépeint le produit sous un angle négatif ou positif ?',  
+'Critique du produit : "'+review+'" Cette critique dépeint le produit sous un angle négatif ou positif ?',  
+'Evaluation du produit : "'+review+'" Cette évaluation dépeint le produit sous un angle négatif ou positif ?',  
+'Le commentaire suivant exprime quel sentiment ?\n Commentaire' +review,  
+"""L'avis suivant exprime quel sentiment ?\n Avis""" +review,  
+'La critique suivante exprime quel sentiment ?\n Critique' +review,  
+"""L'évaluation suivante exprime quel sentiment ?\n Evaluation""" +review
+```
+
+### Features used in the prompts
+In the prompt list above, `review` and `targets` have been constructed from:
+```
+arm = load_dataset('amazon_reviews_multi', 'fr')
+review = arm['train']['review_body'][i]
+targets = arm['train']['stars'][i]
+
+```
+
+
+
+# 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/amazon_reviews_multi_fr_prompt_stars_classification")
+```
+
+# 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 this 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](https://www.amazon.com/gp/help/customer/display.html/ref=footer_cou?ie=UTF8&nodeId=508088) 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.