Update README.md

README.md

@@ -29,16 +29,16 @@ task_ids: []
 
 ## Dataset Description
 
-- **Homepage:**
-- **Repository:**
-- **Paper:**
-- **Leaderboard:**
-- **Point of Contact:**
+- **Repository:** https://github.com/slone-nlp/myv-nmt
+- **Paper:**: [TBD]
+- **Point of Contact:** @cointegrated
 
 ### Dataset Summary
 
 This is a corpus of parallel Erzya-Russian words, phrases and sentences, collected in the paper "The first neural machine translation system for the Erzya language".
 
+Erzya (`myv`) is a language from the Uralic family. It is spoken primarily in the Republic of Mordovia and some other regions of Russia and other post-Soviet countries. We use the Cyrillic version of its script. 
+
 The corpus consists of the following parts:
 
 | name | size | composition | 
@@ -81,7 +81,7 @@ data_extended = load_dataset(
 
 ### Languages
 
-The main part of the dataset (`train`, `dev` and `test`) consists of "natural" Erzya and Russian sentences, translated to the other language by humans. There is also a larger Erzya-only part of the corpus (`mono`), translated to Russian automatically.
+The main part of the dataset (`train`, `dev` and `test`) consists of "natural" Erzya (Cyrillic) and Russian sentences, translated to the other language by humans. There is also a larger Erzya-only part of the corpus (`mono`), translated to Russian automatically.
 
 ## Dataset Structure
 
@@ -102,33 +102,46 @@ All data instances have three string fields: `myv`, `ru` and `src` (the last one
 
 ### Data Splits
 
-[More Information Needed]
+- train: parallel sentences, words and phrases, collected from various sources. Most of them are aligned automatically. Noisy.
+- dev: 1500 parallel sentences, selected from the 6 most reliable and diverse sources.
+- test: same as dev. 
+- mono: Erzya sentences collected from various sources, with the Russian counterpart generated by a neural machine translation model.
 
 ## Dataset Creation
 
 ### Curation Rationale
 
-[More Information Needed]
+This is, as far as we know, the first publicly available parallel Russian-Erzya corpus, and the first medium-sized translation corpus for Erzya. 
+We hope that it sets a meaningful baseline for Erzya machine translation.
 
 ### Source Data
 
 #### Initial Data Collection and Normalization
 
-[More Information Needed]
+The dataset was collected from various sources (see below). 
+
+The texts were spit in sentences using the [razdel]() package. 
+For some sources, sentences were filtered by language using the [slone/fastText-LID-323](https://huggingface.co/slone/fastText-LID-323) model.
+For most of the sources, `myv` and `ru` sentences were aligned automatically using the [slone/LaBSE-en-ru-myv-v1](https://huggingface.co/slone/LaBSE-en-ru-myv-v1) sentence encoder 
+and the code from [the paper repository](https://github.com/slone-nlp/myv-nmt).
 
 #### Who are the source language producers?
 
-[More Information Needed]
+The dataset comprises parallel `myv-ru` and monolingual `myv` texts from diverse sources:
+- 12K parallel sentences from the Bible (http://finugorbib.com);
+- 3K parallel Wikimedia sentences from OPUS;
+- 42K parallel words or short phrases collected from various online dictionaries ();
+- the Erzya Wikipedia and the corresponding articles from the Russian Wikipedia;
+- 18 books, including 3 books with Erzya-Russian bitexts (http://lib.e-mordovia.ru);
+- Soviet-time books and periodicals (https://fennougrica.kansalliskirjasto.fi);
+- The Erzya part of Wikisource (https://wikisource.org/wiki/Main_Page/?oldid=895127);
+- Short texts by modern Erzya authors (https://rus4all.ru/myv/);
+- News articles from the Erzya Pravda website (http://erziapr.ru);
+- Texts found in LiveJournal (https://www.livejournal.com) by searching with the 100 most frequent Erzya words.
 
 ### Annotations
 
-#### Annotation process
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-No human annotation was involved in data collection.
+No human annotation was involved in the data collection.
 
 ### Personal and Sensitive Information
 
@@ -139,7 +152,7 @@ However, some sentences collected, for example, from news articles or LiveJourna
 
 ### Social Impact of Dataset
 
-[More Information Needed]
+Publication of this dataset may attract some attention to the endangered Erzya language.
 
 ### Discussion of Biases
 
@@ -149,18 +162,18 @@ because they appear in the corresponding Wikipedias on similar positions.
 
 ### Other Known Limitations
 
-[More Information Needed]
+The dataset is noisy: some texts in it may be ungrammatical, in a wrong language, or poorly aligned.
 
 ## Additional Information
 
 ### Dataset Curators
 
-[More Information Needed]
+The data was collected by David Dale (https://huggingface.co/cointegrated). 
 
 ### Licensing Information
 
-[More Information Needed]
+The status of the dataset is not final, but after we check everything, we hope to be able to distribute it under the [CC-BY-SA license](http://creativecommons.org/licenses/by-sa/4.0/).
 
 ### Citation Information
 
-[More Information Needed]
+[TBD]