add loading scrip and readme

README.md

@@ -1,3 +1,297 @@
----
-license: cc-by-4.0
----
+---
+annotations_creators:
+- machine-generated
+language_creators:
+- other
+languages:
+- ar
+- as
+- br
+- ca
+- cnh
+- cs
+- cv
+- cy
+- de
+- dv
+- el
+- en
+- eo
+- es
+- et
+- eu
+- fa
+- fr
+- fy-NL
+- ga-IE
+- gn
+- ha
+- ia
+- id
+- it
+- ka
+- ky
+- lt
+- lv
+- mn
+- mt
+- nl
+- or
+- pl
+- pt
+- rm-sursilv
+- rm-vallader
+- ro
+- ru
+- rw
+- sah
+- sk
+- sl
+- sv-SE
+- ta
+- tr
+- tt
+- uk
+- vi
+- zh-CN
+licenses:
+- cc-by-4.0
+multilinguality:
+- multilingual
+pretty_name: Multilingual Spoken Words
+size_categories:
+- 10M<n<100M
+source_datasets:
+- extended|common_voice
+task_categories:
+- speech-processing
+task_ids:
+- other-other-keyword-spotting
+---
+
+# Dataset Card for Multilingual Spoken Words
+
+## 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
+
+- **Homepage:** https://mlcommons.org/en/multilingual-spoken-words/
+- **Repository:** https://github.com/harvard-edge/multilingual_kws
+- **Paper:** https://datasets-benchmarks-proceedings.neurips.cc/paper/2021/file/fe131d7f5a6b38b23cc967316c13dae2-Paper-round2.pdf
+- **Leaderboard:**
+- **Point of Contact:**
+
+### Dataset Summary
+
+Multilingual Spoken Words Corpus is a large and growing audio dataset of spoken
+words in 50 languages collectively spoken by over 5 billion people, for academic
+research and commercial applications in keyword spotting and spoken term search,
+licensed under CC-BY 4.0. The dataset contains more than 340,000 keywords,
+totaling 23.4 million 1-second spoken examples (over 6,000 hours). The dataset
+has many use cases, ranging from voice-enabled consumer devices to call center
+automation. This dataset is generated by applying forced alignment on crowd-sourced sentence-level 
+audio to produce per-word timing estimates for extraction.
+All alignments are included in the dataset.
+
+### Supported Tasks and Leaderboards
+
+Keyword spotting, Spoken term search
+
+### Languages
+
+The dataset is multilingual. To specify several languages to downloading pass a list of them to the
+`language` argument:
+
+```python
+ds = load_dataset("datasets/ml_spoken_words", languages=["ar", "tt", "br"])
+```
+
+The dataset contains data for the following languages:
+
+Low-resourced (<10 hours):
+* Arabic (0.1G, 7.6h)
+* Assamese (0.9M, 0.1h)
+* Breton (69M, 5.6h)
+* Chuvash (28M, 2.1h)
+* Chinese (zh-CN) (42M, 3.1h)
+* Dhivehi (0.7M, 0.04h)
+* Frisian (0.1G, 9.6h)
+* Georgian (20M, 1.4h)
+* Guarani (0.7M, 1.3h)
+* Greek (84M, 6.7h)
+* Hakha Chin (26M, 0.1h)
+* Hausa (90M, 1.0h)
+* Interlingua (58M, 4.0h)
+* Irish (38M, 3.2h)
+* Latvian (51M, 4.2h)
+* Lithuanian (21M, 0.46h)
+* Maltese (88M, 7.3h)
+* Oriya (0.7M, 0.1h)
+* Romanian (59M, 4.5h)
+* Sakha (42M, 3.3h)
+* Slovenian (43M, 3.0h)
+* Slovak (31M, 1.9h)
+* Sursilvan (61M, 4.8h)
+* Tamil (8.8M, 0.6h)
+* Vallader (14M, 1.2h)
+* Vietnamese (1.2M, 0.1h)
+
+Medium-resourced (>10 & <100 hours):
+* Czech (0.3G, 24h)
+* Dutch (0.8G, 70h)
+* Estonian (0.2G, 19h)
+* Esperanto (1.3G, 77h)
+* Indonesian (0.1G, 11h)
+* Kyrgyz (0.1G, 12h)
+* Mongolian (0.1G, 12h)
+* Portuguese (0.7G, 58h)
+* Swedish (0.1G, 12h)
+* Tatar (4G, 30h)
+* Turkish (1.3G, 29h)
+* Ukrainian (0.2G, 18h)
+
+Hig-resourced (>100 hours):
+* Basque (1.7G, 118h)
+* Catalan (8.7G, 615h)
+* English (26G, 1957h)
+* French (9.3G, 754h)
+* German (14G, 1083h)
+* Italian (2.2G, 155h)
+* Kinyarwanda (6.1G, 422h)
+* Persian (4.5G, 327h)
+* Polish (1.8G, 130h)
+* Russian (2.1G, 137h)
+* Spanish (4.9G, 349h)
+* Welsh (4.5G, 108h)
+
+## Dataset Structure
+
+### Data Instances
+
+```python
+{'file': 'абзар_common_voice_tt_17737010.opus',
+ 'is_valid': True,
+ 'language': 0,
+ 'speaker_id': '687025afd5ce033048472754c8d2cb1cf8a617e469866bbdb3746e2bb2194202094a715906f91feb1c546893a5d835347f4869e7def2e360ace6616fb4340e38',
+ 'gender': 0,
+ 'keyword': 'абзар',
+ 'audio': {'path': 'абзар_common_voice_tt_17737010.opus',
+  'array': array([2.03458695e-34, 2.03458695e-34, 2.03458695e-34, ...,
+         2.03458695e-34, 2.03458695e-34, 2.03458695e-34]),
+  'sampling_rate': 48000}}
+```
+
+### Data Fields
+
+* file: strinrelative audio path inside the archive **#TODO: change according to the new local path schema?**
+* is_valid: if a sample is valid
+* language: language of an instance. Makes sense only when providing multiple languages to the 
+dataset loader (for example, `load_dataset("ml_spoken_words", languages=["ar", "tt"])`)
+* speaker_id: unique id of a speaker. Can be "NA" if an instance is invalid
+* gender: speaker gender. Can be one of `["MALE", "FEMALE", "OTHER", "NAN"]`
+* keyword: word spoken in a current sample
+* audio: a dictionary containing the relative path to the audio file, 
+the decoded audio array, and the sampling rate. 
+Note that when accessing the audio column: `dataset[0]["audio"]` the audio file is automatically 
+decoded and resampled to `dataset.features["audio"].sampling_rate`. Decoding and resampling of 
+a large number of audio files might take a significant amount of time. 
+Thus, it is important to first query the sample index before the "audio" column, 
+i.e. `dataset[0]["audio"]` should always be preferred over `dataset["audio"][0]`
+
+### Data Splits
+
+The data for each language is splitted into train / validation / test parts.
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+The data comes form Common Voice dataset.
+
+#### 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
+
+he dataset consists of people who have donated their voice online. 
+You agree to not attempt to determine the identity of speakers.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+The dataset is licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) and can be used for academic
+research and commercial applications in keyword spotting and spoken term search.
+
+### Citation Information
+
+```
+@inproceedings{mazumder2021multilingual,
+  title={Multilingual Spoken Words Corpus},
+  author={Mazumder, Mark and Chitlangia, Sharad and Banbury, Colby and Kang, Yiping and Ciro, Juan Manuel and Achorn, Keith and Galvez, Daniel and Sabini, Mark and Mattson, Peter and Kanter, David and others},
+  booktitle={Thirty-fifth Conference on Neural Information Processing Systems Datasets and Benchmarks Track (Round 2)},
+  year={2021}
+}
+```
+
+### Contributions
+
+Thanks to [@polinaeterna](https://github.com/polinaeterna) for adding this dataset.

ml_spoken_words.py

@@ -0,0 +1,244 @@
+# coding=utf-8
+# Copyright 2022 The HuggingFace Datasets Authors and the current dataset script contributor.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Multilingual Spoken Words Corpus is a large and growing audio dataset of spoken
+words in 50 languages collectively spoken by over 5 billion people, for academic
+research and commercial applications in keyword spotting and spoken term search,
+licensed under CC-BY 4.0. The dataset contains more than 340,000 keywords,
+totaling 23.4 million 1-second spoken examples (over 6,000 hours).
+ """
+
+
+import csv
+from functools import partial
+
+import datasets
+
+
+_CITATION = """\
+@inproceedings{mazumder2021multilingual,
+  title={Multilingual Spoken Words Corpus},
+  author={Mazumder, Mark and Chitlangia, Sharad and Banbury, Colby and Kang, Yiping and Ciro, Juan Manuel and Achorn, Keith and Galvez, Daniel and Sabini, Mark and Mattson, Peter and Kanter, David and others},
+  booktitle={Thirty-fifth Conference on Neural Information Processing Systems Datasets and Benchmarks Track (Round 2)},
+  year={2021}
+}
+"""
+
+_DESCRIPTION = """\
+Multilingual Spoken Words Corpus is a large and growing audio dataset of spoken
+words in 50 languages collectively spoken by over 5 billion people, for academic
+research and commercial applications in keyword spotting and spoken term search,
+licensed under CC-BY 4.0. The dataset contains more than 340,000 keywords,
+totaling 23.4 million 1-second spoken examples (over 6,000 hours). The dataset
+has many use cases, ranging from voice-enabled consumer devices to call center
+automation. This dataset is generated by applying forced alignment on crowd-sourced sentence-level
+audio to produce per-word timing estimates for extraction.
+All alignments are included in the dataset.
+"""
+
+_HOMEPAGE = "https://mlcommons.org/en/multilingual-spoken-words/"
+
+_LICENSE = "CC-BY 4.0."
+
+_VERSION = datasets.Version("1.0.0")
+
+_BASE_URL = "https://huggingface.co/datasets/polinaeterna/ml_spoken_words/resolve/main/data/{lang}/"
+_AUDIO_URL = _BASE_URL + "{split}/audio/{n}.tar.gz"
+_SPLITS_URL = _BASE_URL + "splits.tar.gz"
+_N_FILES_URL = _BASE_URL + "{split}/n_files.txt"
+
+_GENDERS = ["MALE", "FEMALE", "OTHER", "NAN"]
+
+_LANGUAGES = [
+    "ar",
+    "as",
+    "br",
+    "ca",
+    "cnh",
+    "cs",
+    "cv",
+    "cy",
+    "de",
+    "dv",
+    "el",
+    "en",
+    "eo",
+    "es",
+    "et",
+    "eu",
+    "fa",
+    "fr",
+    "fy-NL",
+    "ga-IE",
+    "gn",
+    "ha",
+    "ia",
+    "id",
+    "it",
+    "ka",
+    "ky",
+    "lt",
+    "lv",
+    "mn",
+    "mt",
+    "nl",
+    "or",
+    "pl",
+    "pt",
+    "rm-sursilv",
+    "rm-vallader",
+    "ro",
+    "ru",
+    "rw",
+    "sah",
+    "sk",
+    "sl",
+    "sv-SE",
+    "ta",
+    "tr",
+    "tt",
+    "uk",
+    "vi",
+    "zh-CN",
+]
+
+
+class MlSpokenWordsConfig(datasets.BuilderConfig):
+    """BuilderConfig for MlSpokenWords."""
+
+    def __init__(self, *args, languages, **kwargs):
+        """BuilderConfig for MlSpokenWords.
+        Args:
+            languages (:obj:`Union[List[str], str]`): language or list of languages to load
+            **kwargs: keyword arguments forwarded to super.
+        """
+        super().__init__(
+            *args,
+            name="+".join(languages) if isinstance(languages, list) else languages,
+            **kwargs,
+        )
+        self.languages = languages if isinstance(languages, list) else [languages]
+
+
+class MlSpokenWords(datasets.GeneratorBasedBuilder):
+    """
+    Multilingual Spoken Words Corpus is a large and growing audio dataset of spoken
+    words in 50 languages collectively spoken by over 5 billion people, for academic
+    research and commercial applications in keyword spotting and spoken term search,
+    licensed under CC-BY 4.0. The dataset contains more than 340,000 keywords,
+    totaling 23.4 million 1-second spoken examples (over 6,000 hours).
+    """
+
+    VERSION = _VERSION
+    BUILDER_CONFIGS = [MlSpokenWordsConfig(languages=[lang], version=_VERSION) for lang in _LANGUAGES]
+    BUILDER_CONFIG_CLASS = MlSpokenWordsConfig
+
+    def _info(self):
+        features = datasets.Features(
+            {
+                "file": datasets.Value("string"),
+                "is_valid": datasets.Value("bool"),
+                "language": datasets.ClassLabel(names=self.config.languages),
+                "speaker_id": datasets.Value("string"),
+                "gender": datasets.ClassLabel(names=_GENDERS),
+                "keyword": datasets.Value("string"),  # seems that there are too many of them (340k unique keywords)
+                "audio": datasets.Audio(sampling_rate=48_000),
+            }
+        )
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=features,
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        splits_archive_path = [dl_manager.download(_SPLITS_URL.format(lang=lang)) for lang in self.config.languages]
+        download_audio = partial(_download_audio_archives, dl_manager=dl_manager)
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "audio_archives": [download_audio(split="train", lang=lang) for lang in self.config.languages],
+                    "splits_archives": [dl_manager.iter_archive(path) for path in splits_archive_path],
+                    "split": "train",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                gen_kwargs={
+                    "audio_archives": [download_audio(split="dev", lang=lang) for lang in self.config.languages],
+                    "splits_archives": [dl_manager.iter_archive(path) for path in splits_archive_path],
+                    "split": "dev",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={
+                    "audio_archives": [download_audio(split="test", lang=lang) for lang in self.config.languages],
+                    "splits_archives": [dl_manager.iter_archive(path) for path in splits_archive_path],
+                    "split": "test",
+                },
+            ),
+        ]
+
+    def _generate_examples(self, audio_archives, splits_archives, split):
+        metadata = dict()
+        for lang_idx, lang in enumerate(self.config.languages):
+            for split_filename, split_file in splits_archives[lang_idx]:
+                if split_filename.split(".csv")[0] == split:
+                    csv_reader = csv.reader([line.decode("utf-8") for line in split_file.readlines()], delimiter=",")
+                    for i, (link, word, is_valid, speaker, gender) in enumerate(csv_reader):
+                        if i == 0:
+                            continue
+                        audio_filename = "_".join(link.split("/"))
+                        metadata[audio_filename] = {
+                            "keyword": word,
+                            "is_valid": is_valid,
+                            "speaker_id": speaker,
+                            "gender": gender if gender and gender != "NA" else "NAN",  # some values are "NA"
+                        }
+
+            for audio_archive in audio_archives[lang_idx]:
+                for audio_filename, audio_file in audio_archive:
+                    yield audio_filename, {
+                        "file": audio_filename,
+                        "language": lang,
+                        "audio": {"path": audio_filename, "bytes": audio_file.read()},
+                        **metadata[audio_filename],
+                    }
+
+
+def _download_audio_archives(dl_manager, lang, split):
+    """
+    All audio files are stored in several .tar.gz archives with names like 0.tar.gz, 1.tar.gz, ...
+    Number of archives stored in a separate .txt file (n_files.txt)
+
+    Prepare all the audio archives for iterating over them and their audio files.
+    """
+
+    n_files_url = _N_FILES_URL.format(lang=lang, split=split)
+    n_files_path = dl_manager.download(n_files_url)
+
+    with open(n_files_path, "r", encoding="utf-8") as file:
+        n_files = int(file.read().strip())  # the file contains a number of archives
+
+    archive_urls = [_AUDIO_URL.format(lang=lang, split=split, n=i) for i in range(n_files)]
+    archive_paths = dl_manager.download(archive_urls)
+
+    return [dl_manager.iter_archive(archive_path) for archive_path in archive_paths]