Create README.md

README.md

@@ -0,0 +1,90 @@
+---
+language:
+- fr
+license: 
+- mit
+size_categories:
+- 10K<n<100K
+task_categories:
+- text-classification
+tags:
+- binary-sentiment-analysis
+---
+
+# allocine_fr_prompt_sentiment_analysis
+## Summary
+
+**allocine_fr_prompt_sentiment_analysis** is a subset of the [**Dataset of French Prompts (DFP)**]().
+It contains **X** rows that can be used for a binary sentiment analysis task.
+The original data (without prompts) comes from the dataset [french_book_reviews](https://huggingface.co/datasets/allocine) by Blard.
+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:
+```
+allocine = load_dataset('allocine') 
+review = allocine['train'][i]['review']
+targets = str(allocine['train'][i]['label']).replace("0", "neg").replace("1","pos")
+```
+
+
+
+# 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/allocine_fr_prompt_sentiment_analysis")
+```
+
+# Citation
+## Original data
+> Théophile Blard, French sentiment analysis with BERT, (2020), GitHub repository, https://github.com/TheophileBlard/french-sentiment-analysis-with-bert
+
+
+## This Dataset
+
+
+
+## License
+MIT