Update README.md

README.md

@@ -1,3 +1,274 @@
 ---
-license: cc0-1.0
+annotations_creators:
+- expert-generated
+language:
+- ca
+language_creators:
+- found
+license:
+- cc0-1.0
+multilinguality:
+- monolingual
+pretty_name: '
+
+  annotated_catalan_common_voice_v16.1'
+size_categories:
+- 1M<n<10M
+source_datasets:
+- extended|common_voice
+tags: []
+task_categories:
+- automatic-speech-recognition
+- audio-classification
+- audio-to-audio
+task_ids:
+- audio-language-identification
 ---
+
+# Catalan Common Voice v16.1 - metadata annotated version
+
+## Table of Contents
+- [Dataset Card Creation Guide](#dataset-card-creation-guide)
+  - [Table of Contents](#table-of-contents)
+  - [Dataset Description](#dataset-description)
+    - [Dataset Summary](#dataset-summary)
+    - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+    - [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)
+      - [Initial Data Collection and Normalization](#initial-data-collection-and-normalization)
+      - [Who are the source language producers?](#who-are-the-source-language-producers)
+    - [Annotations](#annotations)
+      - [Annotation process](#annotation-process)
+      - [Who are the annotators?](#who-are-the-annotators)
+    - [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:** [https://projecteaina.cat/tech/](https://projecteaina.cat/tech/)
+- **Point of Contact:** [langech@bsc.es](langech@bsc.es)
+
+### Dataset Summary
+
+This is a new presentation of the corpus [Catalan Common Voice v16.1 - metadata annotated version](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1) 
+with the splits redefined to benchmark ASR models with various Catalan accents: 
+From the validated recording split, we have selected, for each of the main accents of the language (balearic, central, northern, northwestern, valencian), 
+the necessary male and female speakers to gather approximately two and a half hours of varied voice recordings. 
+Thus, we have created ten benchmarking splits, resulting from the combinations of the 5 accents and 2 genders taken into account. 
+
+The recordings of speakers who have not been included in these splits have been grouped into the training split.
+
+### Supported Tasks and Leaderboards
+
+Automatic Speech Recognition.
+
+### Languages
+
+The dataset is in Catalan (ca).
+
+## Dataset Structure
+
+### Data Instances
+
+
+```
+{
+  'client_id': '69dafb41ddc0ea2785719305fdc5c8d79c4b2829d9f3325bda707dcaa553f95c5fbf4b072970d9004d3e31543fcb2c55e252dc904c4fb5aee2a5e5500df90967', 
+  'path': 'common_voice_ca_19909748.mp3', 
+  'sentence': 'En el carrer de l'església es troben bona part dels edificis importants de la vila.', 
+  'up_votes': 2, 
+  'down_votes': 0, 
+  'age': 'thirties', 
+  'gender': 'male', 
+  'accent': 'balear', 
+  'variant': '',
+  'locale': 'ca', 
+  'segment': '',
+  'mean quality': '4.0',
+  'stdev quality': '0.0',
+  'annotated_accent': 'balearic',
+  'annotated_accent_agreement': '100.0',
+  'annotated_gender': 'male',
+  'annotated_gender_agreement': '100.0',
+  'propagated_gender': 'male',
+  'propagated_accents': 'balear',
+  'propagated_accents_normalized': 'balearic',
+  'assigned_accent': 'balearic',
+  'assigned_gender': 'male'
+  
+}
+
+```
+
+
+### Data Fields
+
+Data Fields are kept from [Catalan Common Voice v16.1 - metadata annotated version](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1).
+
+Please refer to the [README](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1) for a detailed explanation of the annotations.
+
+Most of the data fields come from the original [Common Voice corpus](https://commonvoice.mozilla.org/en/datasets):
+
+- `client_id`(string): An id for which client (voice) made the recording
+
+- `path`(string): The path to the audio file
+
+- `sentence`(string): The sentence the user was prompted to speak
+
+- `up_votes`(int64): How many upvotes the audio file has received from reviewers
+
+- `down_votes`(int64): How many downvotes the audio file has received from reviewers
+
+- `age`(string): Self-reported age of the speaker (e.g. teens, twenties, fifties)
+
+- `gender`(string): Self-reported gender of the speaker
+
+- `accent`(string): Self-reported accent of the speaker
+
+- `locale`(string): The locale of the speaker
+
+- `segment`(string): Usually an empty field
+
+In the annotated version of the corpus, we have added the following fields:
+
+- `annotated_gender`(string): Annotated Gender by the experts team.
+
+- `annotated_gender_agreement` (float): Agreement whithin the annotaion team about the gender of the speaker.
+
+- `annotated_accent` (string): Annotated Gender by the experts team.
+
+- `annotated_accent_agreement` (float): Agreement whithin the annotaion team about the accent of the speaker.
+
+- `mean quality` (float): Mean annotated quality of the speakers' recording.
+
+- `stdev quality` (float): Deviation in the quality annotation between annotators.
+  
+- `propagated_gender` (string): Self-declared gender as indicated in certain recordings by the user.
+    
+- `propagated_accents` (string): Self-declared accent as indicated in certain recordings by the user. See [annotations](#annotations) for more information.
+ 
+- `propagated_accents_normalized` (string): Propagated accent, normalized to the closed-options list used until version 7.
+  
+- `assigned_accent` (string): Accent assigned to the speaker.
+
+- `assigned_gender` (string): Gender assigned to the speaker.
+
+### Data Splits
+
+The splits have been reworked to obtain two and a half hours for each of the combinations of the 5 accents and 2 genders considered.
+
+| split	                    | sentences	| speakers | duration (ms) | duration (h) |
+|---------------------------|----------:|---------:|--------------:|-------------:|
+| balearic_female.tsv       |      1673 |      131 |       9146148 |       2.5406 |
+| balearic_male.tsv         |      1596 |      112 |       9012228 |       2.5034 |
+| central_female.tsv        |      1748 |      302 |       9046444 |       2.5130 |
+| central_male.tsv          |      1693 |      346 |       9028570 |       2.5080 |
+| northern_female.tsv       |      1597 |       54 |       9245976 |       2.5683 |
+| northern_male.tsv         |      1601 |       68 |       9173616 |       2.5482 |
+| northwestern_female.tsv   |      1618 |      122 |       9133897 |       2.5372 |
+| northwestern_male.tsv     |      1618 |      134 |       9029382 |       2.5082 |
+| train.tsv                 |   1775349 |    32743 |    9596958679 |    2665.8219 |
+| valencian_female.tsv      |      1744 |      115 |       9149400 |       2.5415 |
+| valencian_male.tsv        |      1623 |      146 |       9004760 |       2.5013 |
+
+
+## Dataset Creation
+
+### Curation Rationale
+
+In light of the lack of data in diverse accents to evaluate Catalan ASR models, we have reworked the data from the [Catalan Common Voice v16.1 - metadata annotated version](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1) 
+to create a benchmark dataset.
+
+We hope that this corpus serves to provide access to speech technologies for Catalan speakers, a minority language, in all its accents.
+
+### Source Data
+
+The original data comes from the [Catalan sentences of the Common Voice corpus](https://commonvoice.mozilla.org/en/datasets)
+
+#### Initial Data Collection and Normalization
+
+The original data comes from [Catalan Common Voice v16.1 - metadata annotated version](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1).
+
+Please refer to the [README file](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1) for a detailed explanation of the annotations.
+
+#### Who are the source language producers?
+
+The original data comes from [Catalan Common Voice v16.1 - metadata annotated version](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1).
+
+### Annotations
+
+The original data comes from [Catalan Common Voice v16.1 - metadata annotated version](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1).
+
+Please refer to the [README file](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1) for a detailed explanation of the annotations.
+
+#### Annotation process
+
+The original data comes from [Catalan Common Voice v16.1 - metadata annotated version](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1).
+
+Please refer to the [README file](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1) for a detailed explanation of the annotations.
+
+#### Who are the annotators?
+
+The original data comes from [Catalan Common Voice v16.1 - metadata annotated version](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1).
+
+Please refer to the [README file](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1) for a detailed explanation of the annotations.
+
+### 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 the Common Voice dataset.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+The dataset consists of people who have donated their voice online. 
+You agree to not attempt to determine the identity of speakers in the Common Voice dataset.
+
+We hope that this corpus serves to provide access to speech technologies for Catalan speakers, a minority language, in all its accents.
+
+### Discussion of Biases
+
+Most of the voices of the common voice in Catalan correspond to men with a central accent between 40 and 60 years old. 
+We have reworked the data from to create an ASR benchmark dataset considering the most habitual genders (female and male) and accents (balearic, central, northern, northwestern, valencian).
+
+Other genders and accents have been excluded due to the lack of data.
+
+Regarding the content of the recorded sentences, we consider that the Common Voice validation system is efficient in removing those that could produce toxic content.
+
+### Other Known Limitations
+
+[N/A]
+
+## Additional Information
+
+### Dataset Curators
+
+Language Technologies Unit at the Barcelona Supercomputing Center (langtech@bsc.es)
+
+This work has been promoted and financed by the Generalitat de Catalunya through the [Aina project](https://projecteaina.cat/).
+
+### Licensing Information
+
+This work is licensed under a [CC0 International License](https://creativecommons.org/publicdomain/zero/1.0/)
+
+### Citation Information
+
+DOI []
+
+### Contributions
+
+The manual annotation of the [Catalan Common Voice v16.1 - metadata annotated version](https://huggingface.co/datasets/projecte-aina/annotated_catalan_common_voice_v16.1) was entrusted to the [STeL](https://stel2.ub.edu/el-servei) team from the University of Barcelona.