Update README.md

README.md

@@ -31,4 +31,141 @@ configs:
     path: data/validation-*
   - split: test
     path: data/test-*
+license: cc-by-sa-4.0
+language:
+- ru
+- myv
+task_categories:
+- sentence-similarity
+- text-classification
+- translation
+size_categories:
+- 1K<n<10K
 ---
+# Dataset Card for Dataset Name
+
+A small parallel Erzya-Russian dataset, manually annotated for quality: meaning preservation and fluency of the Erzya sentences.
+
+## Dataset Details
+
+### Dataset Description
+
+
+- **Curated by:** David Dale, Árpád Váldazs
+- **Language(s) (NLP):** Erzya, Russian
+- **License:** CC-BY-SA-4.0
+
+### Dataset Sources
+
+- **Repository:** https://github.com/slone-nlp/myv-nmt/
+- **Paper:** https://www2.statmt.org/wmt24/pdf/2024.wmt-1.49.pdf
+
+## Uses
+
+Evaluation of automatic metrics of machine translation into Erzya, or of Erzya parallel data quality.
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+
+The dataset consists of the validation and test splits of [slone/myv_ru_2022](https://huggingface.co/datasets/slone/myv_ru_2022), and follows the same structure.
+This includes the following fields:
+- `id`: numeric id of the sentence in the split, the same as in the original dataset.
+- `ru`: a sentence in Russian
+- `myv`: a corresponding sentence in Erzya
+- `src`: a sring identifier of the data source
+
+There are three additional fields, new to this version of the dataset:
+- `meaning_score`: a score of semantic similarity between the Russian and the Erzya sentences. Possible values are `0` (a huge difference in the meaning), `0.5` (difference in minor details), and `1` (equivalent meaning).
+- `fluency_score`: a score of fluency of the Erzya sentence. Possible values are `0` (serious problems with fluency or grammaticality, or a wrong language), `0.5` (the sentence is acceptable but does not feel natural), and `1` (fluent).
+- `is_good`: a flag that the translation pair is good; equals `1` if both scores above are `1`, and `0`, otherwise.
+
+The splits of the dataset contain 1500 sentence pairs each.
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+
+[More Information Needed]
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+#### Data Collection and Processing
+
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+
+[More Information Needed]
+
+#### Who are the source data producers?
+
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+
+[More Information Needed]
+
+### Annotations [optional]
+
+<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+
+#### Annotation process
+
+<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+<!-- This section describes the people or systems who created the annotations. -->
+
+[More Information Needed]
+
+#### Personal and Sensitive Information
+
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+
+## Citation [optional]
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+[More Information Needed]
+
+**APA:**
+
+[More Information Needed]
+
+## Glossary [optional]
+
+<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+
+[More Information Needed]
+
+## More Information [optional]
+
+[More Information Needed]
+
+## Dataset Card Authors [optional]
+
+[More Information Needed]
+
+## Dataset Card Contact
+
+[More Information Needed]