Adding more info the README file

README.md

@@ -24,13 +24,11 @@ task_categories:
 task_ids: []
 ---
 
-
 # Dataset Card for ravnursson_asr
-
 ## Table of Contents
 - [Dataset Description](#dataset-description)
   - [Dataset Summary](#dataset-summary)
-  - [Supported Tasks](#supported-tasks)
+  - [Supported Tasks](#supported-tasks-and-leaderboards)
   - [Languages](#languages)
 - [Dataset Structure](#dataset-structure)
   - [Data Instances](#data-instances)
@@ -55,16 +53,12 @@ task_ids: []
 - **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:** [[email protected]] (mailto:[email protected]), [[email protected]] (mailto:[email protected])
-
+- **Point of Contact:** [[email protected]](mailto:[email protected]), [[email protected]](mailto:[email protected])
 
 ### 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 
@@ -73,88 +67,113 @@ The speech files are made of 249 female speakers and 184 male speakers; 433 spea
     
 [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
+
+### Example Usage
+The RAVNURSSON Corpus is divided in 3 splits: train, validation and test. To load a specific split pass its name as a config name:
+```python
+from datasets import load_dataset
+ravnursson = load_dataset("carlosdanielhernandezmena/ravnursson_asr")
+```
+To load an specific split (for example, the train split) type:
+```python
+ravnursson = load_dataset("carlosdanielhernandezmena/ravnursson_asr",split="train")
+```
 
 ### 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).
+* automatic-speech-recognition: 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
+* `audio_id` (string) - id of audio segment
+* `audio` (datasets.Audio) - a dictionary containing the path to the audio, the decoded audio array, and the sampling rate. In non-streaming mode (default), the path points to the locally extracted audio. In streaming mode, the path is the relative path of an audio inside its archive (as files are not downloaded and extracted locally).
+* `speaker_id` (string) - id of speaker
+* `gender` (string) - gender of speaker (male or female)
+* `age` (string) - range of age of the speaker: Younger (15-35), Middle-aged (36-60), Elderly (61+).
+* `duration` (float32) - duration of the audio file in seconds.
+* `normalized_text` (string) - normalized audio segment transcription
+* `dialect` (string) - dialect group, for example "Suðuroy" or "Sandoy".
 
+### Data Splits
+The speech material has been subdivided into portions for training (train), dev (evaluation) and testing (test). Lengths of every portion are: train = 100h08m, test = 4h30m, dev (evaluation)=4h30m.
 
+To load an specific portion please see the section "Example Usage".
 
-### 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)
+The test and validation portions contain the excact same amount of audio each (4.5 hours) and the same number of male (10) and female (10) speakers each.
 
 ## Dataset Creation
 
 ### Curation Rationale
-[Needs More Information]
+
+The directory called "speech" contains all the speech files of the corpus. The files in the speech directory are divided in three directories: train, dev and test. The train portion is sub-divided in three types of recordings: RDATA1O, RDATA1OP and RDATA2; this is due the organization of the recordings in the original BLARK 1.0. There, the recordings are divided in Rdata1 and Rdata2.
+
+One main difference between Rdata1 and Rdata2 is that the reading environment for Rdata2 was controlled by a software called "PushPrompt" which is included in the original BLARK 1.0. Another main difference is that in Rdata1 there are some available transcriptions labeled at the phoneme level. For this reason the audio files in the speech directory of the RAVNURSSON corpus are divided in the folders RDATA1O where "O" is for "Orthographic" and RDATA1OP where "O" is for Orthographic and "P" is for phonetic.
+
+In the case of the dev and test portions, the data come only from Rdata2 which does not have labels at the phonetic level.
+
+It is important to clarify that the RAVNURSSON Corpus only includes transcriptions at the orthographic level.
+
 ### Source Data
+
 #### Initial Data Collection and Normalization
-[Needs More Information]
+The dataset was released with normalized text only at an orthographic level in lower-case. The normalization process was performed by automatically removing punctuation marks and characters that are not present in the Faroese alphabet.
+
 #### Who are the source language producers?
-[Needs More Information]
+
+* The utterances were recorded using a TASCAM DR-40.
+
+* The audio files in this corpus are distributed in a flac format at 16kHz@16bit mono.
+
+* Participants self-reported their age group, gender, native language and dialect.
+
+* Participants are aged between 15 to 83 years. 
+ 
+* The corpus contains 71949 speech files from 433 speakers, totalling 109 hours and 9 minutes.
+
 ### Annotations
+
 #### Annotation process
-[Needs More Information]
+
+The reading prompts were selected by experts from a text corpus. The prompts were selected to be phonetically balanced and to avoid profane language. Then, a software tool called PushPrompt were used for reading sessions (voice recordings). PushPromt presents the text items in the reading material to the reader, allowing him/her to manage the session interactively (adjusting the reading tempo, repeating speech productions at wish, inserting short breaks as needed, etc.). When the reading session is completed, a log file (with time stamps for each production) is written as a data table compliant with the TextGrid-format. 
+
 #### Who are the annotators?
-The corpus was annotated by the Ravnur Project https://maltokni.fo/en/the-ravnur-project
+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.
+The dataset consists of people who have donated their voice. 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
 
+### 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.
+
+"RAVNURSSON FAROESE SPEECH AND TRANSCRIPTS" by Carlos Daniel Hernández Mena and Annika Simonsen is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) License with the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
 ## Additional Information
 ### Dataset Curators
 The dataset was created by Annika Simonsen and curated by Carlos Daniel Hernández Mena.
@@ -171,7 +190,4 @@ The dataset was created by Annika Simonsen and curated by Carlos Daniel Hernánd
 ```
 ### 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.
-
-