Update README.md

README.md

@@ -1,3 +1,175 @@
----
-license: cc-by-nc-nd-4.0
----
+---
+license: cc-by-nc-nd-4.0
+language:
+- ru
+- en
+- fi
+- myv
+- mrj
+- kca
+- koi
+- kpv
+- olo
+- mns
+- mhr
+- mdf
+- udm
+- vep
+- krl
+task_categories:
+- translation
+pretty_name: finugorbib
+size_categories:
+- 100K<n<1M
+---
+
+# finugorbib data card
+
+<!-- Provide a quick summary of the dataset. -->
+
+This a text of the Bible, translated into 12 Finno-Ugric languages (see below), and aligned with Russian, English and Finnish.
+This dataset was downloaded from http://finugorbib.com.
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+- **Curated by:** SLONE contributors
+- **Language(s) (NLP):** Erzya, Hill (Western) Mari, Khanty, Komi-Permyak, Komi-Zyrian, Livvi-Karelian,
+  Mansi, Meadow (Eastern) Mari, Moksha, Udmurt, Veps, Northern Karelian,
+  English, Finnish and Russian
+- **License:**: Each text has the following copyright notice by the text creators (loosely equivalent to CC BY-NC-ND 4.0): 
+
+```
+© Институт перевода Библии Хельсинки {ГОД}
+© Institute for Bible Translation Helsinki {YEAR}
+{НАЗВАНИЕ КНИГИ, напр. Псалтирь на мордовском-эрзя языке}
+{BOOK NAME, e.g. The Psalms in the Mordvin-Erzya language}
+
+Можно использовать и распространять свободно в некоммерческих целях под следующими условиями:
+Вам нельзя изменить текст.
+Вы должны включить эту информацию об авторских правах при текста.
+
+Если Вы хотите иметь эту Библию на вашем сайте, в котором Вы в каком-то месте просите пожертвования, Вам необходимо попросить письменное разрешение от ИПБ Финляндии.
+
+Free non-commercial distribution under the following conditions:
+You may not alter any of these texts.
+You must include this copyright notice.
+
+If you want to have this Bible on your website, where you ask anywhere in it for donations, you need to ask for written permission from IBT Finland.
+```
+
+Below is the brief information about the languages
+
+| Language | Language code on the website | ISO 639-3 | Glottolog |
+| - | - | - | - |
+| Erzya | `erzya` | `myv` | `erzy1239` |
+| Hill (Western) Mari| `hill_mari` | `mrj` | `west2392` |
+| Khanty | `khanty` | `kca` | `khan1279` |
+| Komi-Permyak | `komi_permyak` | `koi` | `komi1269` | 
+| Komi-Zyrian | `komi_zyrian` | `kpv` | `komi1268` | 
+| Livvi-Karelian | `livvi` | `olo` | `livv1243` | 
+| another copy of Livvi-Karelian data | `livviksi` |
+| Mansi | `mansi` | `mns` | `mans1269` | 
+| Meadow (Eastern) Mari | `meadow_mari` | `mhr` | `east2328` | 
+| Moksha | `moksha` | `mdf` | `moks1248` |
+| Udmurt | `udmurt` | `udm` | `udmu1245`| 
+| Veps | `vepsa` | `vep` | `veps1250` | 
+| Northern Karelian | `viena` | `krl` | `nort2673` | 
+
+Notes:
+
+* Khanty and Mansi are macrolanguages, but the language variants were not specified.
+* Northern Karelian is considered a dialect of Karelian and doesn't have its proper ISO 639-3 code.
+
+
+### Dataset Sources
+
+The dataset has been downloaded from http://finugorbib.com/.
+
+Its constituents and the corresponding copyritght notices are listed in the file `COPYRIGHT.md`
+
+
+
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+[More Information Needed]
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+
+[More Information Needed]
+
+## 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. -->
+
+[More Information Needed]
+
+## 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.