add dataset metadate

voxpopuli.py

@@ -7,6 +7,39 @@ from tqdm.auto import tqdm
 import datasets
 
 
+_DESCRIPTION = """
+A large-scale multilingual speech corpus for representation learning, semi-supervised learning and interpretation.
+"""
+
+_CITATION = """
+@inproceedings{wang-etal-2021-voxpopuli,
+    title = "{V}ox{P}opuli: A Large-Scale Multilingual Speech Corpus for Representation Learning, 
+    Semi-Supervised Learning and Interpretation",
+    author = "Wang, Changhan  and
+      Riviere, Morgane  and
+      Lee, Ann  and
+      Wu, Anne  and
+      Talnikar, Chaitanya  and
+      Haziza, Daniel  and
+      Williamson, Mary  and
+      Pino, Juan  and
+      Dupoux, Emmanuel",
+    booktitle = "Proceedings of the 59th Annual Meeting of the Association for Computational Linguistics 
+    and the 11th International Joint Conference on Natural Language Processing (Volume 1: Long Papers)",
+    month = aug,
+    year = "2021",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2021.acl-long.80",
+    doi = "10.18653/v1/2021.acl-long.80",
+    pages = "993--1003",
+}
+"""
+
+_HOMEPAGE = "https://github.com/facebookresearch/voxpopuli"
+
+_LICENSE = "CC0, also see https://www.europarl.europa.eu/legal-notice/en/"
+
+
 _LANGUAGES = sorted(
     [
         "en", "de", "fr", "es", "pl", "it", "ro", "hu", "cs", "nl", "fi", "hr",
@@ -15,6 +48,14 @@ _LANGUAGES = sorted(
 )
 _LANGUAGES_V2 = [f"{x}_v2" for x in _LANGUAGES]
 
+_ASR_LANGUAGES = [
+    "en", "de", "fr", "es", "pl", "it", "ro", "hu", "cs", "nl", "fi", "hr",
+    "sk", "sl", "et", "lt"
+]
+_ASR_ACCENTED_LANGUAGES = [
+    "en_accented"
+]
+
 _YEARS = list(range(2009, 2020 + 1))
 
 # unnecessary
@@ -22,7 +63,7 @@ _CONFIG_TO_LANGS = {
     "400k": _LANGUAGES,
     "100k": _LANGUAGES,
     "10k": _LANGUAGES,
-    "asr": ["original"],
+    "asr": _ASR_LANGUAGES,  # + _ASR_ACCENTED_LANGUAGES
 }
 
 _CONFIG_TO_YEARS = {
@@ -43,7 +84,11 @@ _BASE_URL = "https://dl.fbaipublicfiles.com/voxpopuli/"
 
 _DATA_URL = _BASE_URL + "audios/{lang}_{year}.tar"
 
-_META_URL = _BASE_URL + "annotations/unlabelled_v2.tsv.gz"
+_ASR_DATA_URL = _BASE_URL + "audios/original_{year}.tar"
+
+_UNLABELLED_META_URL = _BASE_URL + "annotations/unlabelled_v2.tsv.gz"
+
+_ASR_META_URL = _BASE_URL + "annotations/asr/asr_{lang}.tsv.gz"
 
 
 class VoxpopuliConfig(datasets.BuilderConfig):
@@ -57,24 +102,23 @@ class VoxpopuliConfig(datasets.BuilderConfig):
         """
         super().__init__(name=name, **kwargs)
         name = name.split("_")[0]
-        self.languages = [name] if name in _LANGUAGES else _LANGUAGES
+        self.languages = [name] if name in _LANGUAGES else _CONFIG_TO_LANGS[name]
         self.years = _CONFIG_TO_YEARS[name]
 
 
 class Voxpopuli(datasets.GeneratorBasedBuilder):
-    """The Voxpopuli dataset."""
+    """The VoxPopuli dataset."""
 
-    VERSION = datasets.Version("1.0.0")  # TODO ??
+    VERSION = datasets.Version("1.3.0")  # not sure
     BUILDER_CONFIGS = [
         VoxpopuliConfig(
             name=name,
-            # version=VERSION,
-            description="",  # TODO
+            version=datasets.Version("1.3.0"),
             )
         for name in _LANGUAGES + _LANGUAGES_V2 + ["10k", "100k", "400k"]
     ]
     # DEFAULT_CONFIG_NAME = "400k"
-    DEFAULT_WRITER_BATCH_SIZE = 256
+    DEFAULT_WRITER_BATCH_SIZE = 256  # SET THIS TO A LOWER VALUE IF IT USES TOO MUCH RAM SPACE
 
     def _info(self):
         try:
@@ -98,14 +142,14 @@ class Voxpopuli(datasets.GeneratorBasedBuilder):
             }
         )
         return datasets.DatasetInfo(
-            # description=_DESCRIPTION,
+            description=_DESCRIPTION,
             features=features,
-            # homepage=_HOMEPAGE,
-            # license=_LICENSE,
-            # citation=_CITATION,
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            citation=_CITATION,
         )
 
-    def _read_metadata(self, metadata_path):
+    def _read_metadata_unlabelled(self, metadata_path):
         #  from https://github.com/facebookresearch/voxpopuli/blob/main/voxpopuli/get_unlabelled_data.py#L34
         def predicate(id_):
             is_plenary = id_.find("PLENARY") > -1
@@ -133,8 +177,11 @@ class Voxpopuli(datasets.GeneratorBasedBuilder):
 
         return metadata
 
+    def _read_metadata_asr(self, metadata_paths):
+        pass
+
     def _split_generators(self, dl_manager):
-        metadata_path = dl_manager.download_and_extract(_META_URL)
+        metadata_path = dl_manager.download_and_extract(_UNLABELLED_META_URL)
 
         urls = [_DATA_URL.format(lang=language, year=year) for language in self.config.languages for year in self.config.years]
         dl_manager.download_config.num_proc = len(urls)