First information added to the README file

README.md

@@ -23,3 +23,155 @@ task_categories:
 - automatic-speech-recognition
 task_ids: []
 ---
+
+
+# Dataset Card for ravnursson_asr
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks](#supported-tasks)
+  - [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:** [Ravnursson Faroese Speech and Transcripts](http://hdl.handle.net/20.500.12537/276)
+- **Repository:** [Clarin.is] (http://hdl.handle.net/20.500.12537/276)
+- **Paper:** [Creating a basic language resource kit for faroese.](https://aclanthology.org/2022.lrec-1.495.pdf)
+- **Point of Contact:** [carlos.mena@ciempiess.org] (mailto:carlos.mena@ciempiess.org), [annika.simonsen@hotmail.com] (mailto:annika.simonsen@hotmail.com)
+
+
+### Dataset Summary
+The corpus "RAVNURSSON FAROESE SPEECH AND TRANSCRIPTS" (or RAVNURSSON Corpus for short) is a collection of speech recordings with transcriptions intended for Automatic Speech Recognition (ASR) applications in the language that is spoken at the Faroe Islands (Faroese). It was curated at the Reykjavík University (RU) in 2022.
+
+The RAVNURSSON Corpus is an extract of the "Basic Language Resource Kit 1.0" (BLARK 1.0) [1] developed by the Ravnur Project from the Faroe Islands [2]. As a matter of fact, the name RAVNURSSON comes from Ravnur (a tribute to the Ravnur Project) and the suffix "son" which in Icelandic means "son of". Therefore, the name "RAVNURSSON" means "The (Icelandic) son of Ravnur". The double "ss" is just for aesthetics.
+
+The audio was collected by recording speakers reading texts. The participants are aged 15-83, divided into 3 age groups: 15-35, 36-60 and 61+.
+
+The speech files are made of 249 female speakers and 184 male speakers; 433 speakers total. The recordings were made on TASCAM DR-40 Linear PCM audio recorders using the built-in stereo microphones in WAVE 16 bit with a sample rate of 48kHz, but then, downsampled to 16kHz@16bit mono for this corpus.
+
+[1] Simonsen, A., Debess, I. N., Lamhauge, S. S., & Henrichsen, P. J. Creating 
+    a basic language resource kit for Faroese. In LREC 2022. 13th International 
+    Conference on Language Resources and Evaluation.
+    
+[2] Website. The Project Ravnur under the Talutøkni Foundation
+    https://maltokni.fo/en/the-ravnur-project
+    
+[3] Software. Pandas (Python Library). https://pandas.pydata.org
+
+### Supported Tasks
+- `automatic-speech-recognition`, `speaker-identification`: The dataset can be used to train a model for Automatic Speech Recognition (ASR). The model is presented with an audio file and asked to transcribe the audio file to written text. The most common evaluation metric is the word error rate (WER).
+
+### Languages
+The audio is in Faroese.
+The RAVNURSSON Corpus transcriptions have been hand verified. The training subset was balanced for phonetic and dialectal coverage; Test and Dev subsets are gender-balanced. Tabular computer-searchable information is included as well as written documentation.
+
+## Dataset Structure
+
+### Data Instances
+
+
+
+### Data Fields
+
+
+
+### Data Splits
+The speech material has been subdivided into portions for training and
+testing. The default train-test split will be made available on data download.
+The test data alone has a core portion containing 24 speakers, 2 male and 1 female
+from each dialect region. More information about the test set can
+be found [here](https://catalog.ldc.upenn.edu/docs/LDC93S1/TESTSET.TXT)
+
+## Dataset Creation
+
+### Curation Rationale
+[Needs More Information]
+### Source Data
+#### Initial Data Collection and Normalization
+[Needs More Information]
+#### Who are the source language producers?
+[Needs More Information]
+### Annotations
+#### Annotation process
+[Needs More Information]
+#### Who are the annotators?
+The corpus was annotated by the Ravnur Project https://maltokni.fo/en/the-ravnur-project
+### Personal and Sensitive Information
+The dataset consists of people who have donated their voice online. You agree to not attempt to determine the identity of speakers in this dataset.
+## Considerations for Using the Data
+### Social Impact of Dataset
+This is the first ASR corpus in Faroese.
+### Discussion of Biases
+
+As the number of reading prompts was limited, the common denominator in the RAVNURSSON corpus is that one prompt is read by more than one speaker. This is relevant because is a common practice in ASR to create a language model using the prompts that are found in the train portion of the corpus. That is not recommended for the RAVNURSSON Corpus as it counts with many prompts shared by all the portions and that will produce an important bias in the language modeling task.
+
+In this section we present some statistics about the repeated prompts through all the portions of the corpus.
+
+- In the train portion:
+
+	* Total number of prompts = 65616
+	* Number of unique prompts = 38646
+
+There are 26970 repeated prompts in the train portion. In other words, 41.1% of the prompts are repeated.
+
+- In the test portion:
+
+	* Total number of prompts = 3002
+	* Number of unique prompts = 2887
+
+There are 115 repeated prompts in the test portion. In other words, 3.83% of the prompts are repeated.
+
+- In the dev portion:
+
+	* Total number of prompts = 3331
+	* Number of unique prompts = 3302
+
+There are 29 repeated prompts in the dev portion. In other words, 0.87% of the prompts are repeated.
+
+- Considering the corpus as a whole:
+
+	* Total number of prompts = 71949
+	* Number of unique prompts = 39945
+
+There are 32004 repeated prompts in the whole corpus. In other words, 44.48% of the prompts are repeated.
+
+### Other Known Limitations
+Dataset provided for research purposes only. Please check dataset license for additional information.
+## Additional Information
+### Dataset Curators
+The dataset was created by Annika Simonsen and curated by Carlos Daniel Hernández Mena.
+### Licensing Information
+[CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/)
+### Citation Information
+```
+@misc{carlosmenaravnursson2022,
+      title={Ravnursson Faroese Speech and Transcripts}, 
+      author={Hernandez Mena, Carlos Daniel and Simonsen, Annika},
+      year={2022},
+      url={http://hdl.handle.net/20.500.12537/276},
+}
+```
+### Contributions
+This project was made possible under the umbrella of the Language Technology Programme for Icelandic 2019-2023. The programme, which is managed and coordinated by Almannarómur, is funded by the Icelandic Ministry of Education, Science and Culture.
+
+Special thanks to Dr. Jón Guðnason, professor at Reykjavík University and head of the Language and Voice Lab (LVL) for providing computational resources.
+
+