Dataset card written from measured statistics

README.md

@@ -1,14 +1,14 @@
 ---
-annotations_creators:
-- found
-language_creators:
-- found
+license: mit
 language:
 - ru
-license: mit
+annotations_creators:
+- crowdsourced
+language_creators:
+- expert-generated
 multilinguality:
 - monolingual
-pretty_name: cedr-m7
+pretty_name: CEDR M7
 size_categories:
 - 1K<n<10K
 source_datasets:
@@ -16,127 +16,57 @@ source_datasets:
 task_categories:
 - text-classification
 task_ids:
-- sentiment-classification
+- multi-label-classification
+tags:
+- emotion-recognition
+- russian
+- text
 ---
 
-# Dataset Card for CEDR-M7
-
-## 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:**
-- **Leaderboard:**
-- **Point of Contact:**
-
-### Dataset Summary
-
-[More Information Needed]
-
-### Supported Tasks and Leaderboards
-
-[More Information Needed]
-
-### Languages
-
-[More Information Needed]
-
-## Dataset Structure
-
-### Data Instances
-
-[More Information Needed]
-
-### Data Fields
+![CEDR M7](assets/banner.svg)
 
-[More Information Needed]
+# CEDR M7
 
-### Data Splits
+Russian text emotion corpus, adapted to seven Aniemore classes.
 
-[More Information Needed]
+## Provenance
 
-## Dataset Creation
+**This corpus is not ours.** It is an adaptation: the source is [`sagteam/cedr_v1`](https://huggingface.co/datasets/sagteam/cedr_v1), and Aniemore's contribution is remapping it onto the seven classes the rest of the library uses. Credit for the collection and the original annotation belongs to the CEDR authors.
 
-### Curation Rationale
+## Splits
 
-[More Information Needed]
+| Split | Rows | Mean words |
+|---|---:|---:|---:|
+| `train` | 7528 | — | 14.8 |
+| `test` | 1882 | — | 14.6 |
 
-### Source Data
+<img src="assets/classes.svg" alt="Class distribution" width="760">
 
-#### Initial Data Collection and Normalization
+## Fields
 
-[More Information Needed]
+| Column | Meaning |
+|---|---|
+| `text` | Transcript of the utterance |
+| `labels` | Emotion labels, multi-label |
+| `source` | Where the text came from |
+| `label2ids` | Label indices in the source ordering |
 
-#### Who are the source language producers?
+## Usage
 
-[More Information Needed]
+```python
+from datasets import load_dataset
 
-### Annotations
-
-#### Annotation process
-
-[More Information Needed]
-
-#### 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]
+ds = load_dataset("Aniemore/cedr-m7")
+print(ds["train"][0]["text"], ds["train"][0]["labels"])
+```
 
-### Licensing Information
+## Limitations
 
-[More Information Needed]
+`disgust` is effectively absent: 17 rows in `train`, 3 rows in `test`. Any per-class number for it is noise, and it drags macro averages down. The class distribution is otherwise heavily skewed toward `neutral`.
 
-### Citation Information
+## Citation
 
-```
+```bibtex
 @misc{Aniemore,
   author = {Артем Аментес, Илья Лубенец, Никита Давидчук},
   title = {Открытая библиотека искусственного интеллекта для анализа и выявления эмоциональных оттенков речи человека},
@@ -148,6 +78,8 @@ task_ids:
 }
 ```
 
-### Contributions
+Please also cite the original CEDR corpus, [`sagteam/cedr_v1`](https://huggingface.co/datasets/sagteam/cedr_v1).
+
+## License
 
-Thanks to [@toiletsandpaper](https://github.com/toiletsandpaper) for adding this dataset.
+MIT.