Update README.md

README.md

@@ -43,4 +43,185 @@ language:
 - fr
 tags:
 - emotions
----
+---
+
+# Dataset Card for [Dataset Name]
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+- [Dataset Summary](#dataset-summary)
+- [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+- [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+- [Data Instances](#data-instances)
+- [Data Fields](#data-fields)
+- [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+- [Curation Rationale](#curation-rationale)
+- [Source Data](#source-data)
+- [Annotations](#annotations)
+- [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+- [Social Impact of Dataset](#social-impact-of-dataset)
+- [Discussion of Biases](#discussion-of-biases)
+- [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+- [Dataset Curators](#dataset-curators)
+- [Licensing Information](#licensing-information)
+- [Citation Information](#citation-information)
+- [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage:**
+- **Repository:**
+- **Paper:** https://arxiv.org/abs/2405.14385
+- **Leaderboard:**
+- **Point of Contact:** Gwénolé Lecorvé
+
+### Dataset Summary
+
+EmoTextToKids provides sentences from written documents annotated in emotions.
+Emotions are characterized by their emotional category (fear, anger, pride...) and their expression mode (labeled, behavioral, displayed or suggester).
+As opposed to usual datasets in emotion recognition, the documents are **not** conversational. They are newspapers, encyclopedias, novels, dedicated to children.
+
+### Supported Tasks and Leaderboards
+
+- Emotion recognition
+
+### Languages
+
+- French
+
+## Dataset Structure
+
+### Data Instances
+
+```json
+{
+"previous_sentence": "Un an plus tard, le Sénat lui accorde la dictature sans limite dans le temps. ",
+"target_sentence": "Mais à Rome, la gloire de César inquiète certains sénateurs. ",
+"next_sentence": "Un complot commence à s’organiser autour d’un homme nommé Cassius. ",
+"is_emotional": true,
+"modes": [
+"désigné"
+],
+"types": [
+"base"
+],
+"categories": [
+"peur"
+]
+}
+```
+
+The fields `modes`, `types` and `categories` are lists because several emotions can be present in a unique sentence.
+
+### Data Fields
+
+[More Information Needed]
+
+### Data Splits
+
+| Subset | Texts | Sent. | Tokens | Emotional sent. |
+|--------|-------|--------|--------|-----------------|
+| train | 1,129 | 19,553 | 360K | 3,952 |
+| dev | 182 | 2,770 | 53K | 438 |
+| test | 283 | 5,588 | 102K | 984 |
+| Total | 1,594 | 27,911 | 515K | 5,374 |
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+Data were manually annotated by 6 experts following annotation guidelines here: https://hal.science/hal-03263194 .
+
+Annotations were validated by comparing a significant sample of the annotated data with annotation of an external expert. Below are the kappa coefficients.
+
+| Label | Kappa |
+|---------------|-------|
+| emotional | 0.66 |
+|---------------|-------|
+| behavioral | 0.70 |
+| labeled | 0.73 |
+| displayed | 0.68 |
+| suggested | 0.46 |
+|---------------|-------|
+| basic | 0.66 |
+| complex | 0.55 |
+|---------------|-------|
+| admiration | 0.53 |
+| anger | 0.71 |
+| guilt | 0.50 |
+| disgust | 0.87 |
+| embarrassment | 0.51 |
+| pride | 0.25 |
+| jealousy | 1.00 |
+| joy | 0.51 |
+| fear | 0.64 |
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+
+```bibtex
+
+
+@misc
+
+{étienne2024emotion,
+title={Emotion Identification for French in Written Texts: Considering their Modes of Expression as a Step Towards Text Complexity Analysis},
+author={Aline Étienne and Delphine Battistelli and Gwénolé Lecorvé},
+year={2024},
+eprint={2405.14385},
+archivePrefix={arXiv},
+primaryClass={cs.CL}
+}
+```