Update README.md

README.md

@@ -8,4 +8,163 @@ source_datasets: []
 task_categories:
 - automatic-speech-recognition
 task_ids: []
----
+---
+
+# Dataset Card for Voxpopuli
+
+## Table of Contents
+- [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)
+  - [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
+
+### Dataset Summary
+
+### Example usage
+
+HyVoxPopuli contains labelled data for 18 languages. To load a specific language pass its name as a config name:
+
+```python
+from datasets import load_dataset
+
+voxpopuli_croatian = load_dataset("Edmon02/hyvoxpopuli")
+```
+
+### Supported Tasks and Leaderboards
+
+* 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).
+
+Accented English subset can also be used for research in ASR for accented speech (15 L2 accents)
+
+## Dataset Structure
+
+### Data Instances
+
+```python
+{
+  'audio_id': '20180206-0900-PLENARY-15-hr_20180206-16:10:06_5',
+  'language': 11,  # "hr"
+  'audio': {
+    'path': '/home/polina/.cache/huggingface/datasets/downloads/extracted/44aedc80bb053f67f957a5f68e23509e9b181cc9e30c8030f110daaedf9c510e/train_part_0/20180206-0900-PLENARY-15-hr_20180206-16:10:06_5.wav',
+    'array': array([-0.01434326, -0.01055908,  0.00106812, ...,  0.00646973], dtype=float32),
+    'sampling_rate': 16000
+  },
+  'raw_text': '',
+  'normalized_text': 'poast genitalnog sakaenja ena u europi tek je jedna od manifestacija takve tetne politike.',
+  'gender': 'female',
+  'speaker_id': '119431',
+  'is_gold_transcript': True,
+  'accent': 'None'
+}
+```
+
+### 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).
+* `raw_text` (string) - original (orthographic) audio segment text
+* `normalized_text` (string) - normalized audio segment transcription
+* `gender` (string) - gender of speaker
+* `speaker_id` (string) - id of speaker
+* `is_gold_transcript` (bool) - ?
+* `accent` (string) - type of accent, for example "en_lt", if applicable, else "None".
+
+### Data Splits
+
+All configs contain data in three splits: train, validation and test.
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+The raw data is collected from [Գրքասեր site ](https://grqaser.org/am)
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+
+Please cite this paper:
+
+```bibtex
+@inproceedings{wang-etal-2021-voxpopuli,
+    title = "{H}y{V}ox{P}opuli: A Large-Scale Multilingual Speech Corpus for Representation Learning, Semi-Supervised Learning and Interpretation",
+    author = "Edmon, Sahakyan",
+    booktitle = "Գրքասեր site audio and pdf books",
+    month = feb,
+    year = "2024",
+    address = "Online",
+    publisher = "Researcher"
+}
+```
+
+### Contributions
+
+Thanks to [@polinaeterna](https://github.com/polinaeterna) for adding this dataset.