add source code

README.md

@@ -1,3 +1,151 @@
 ---
+pretty_name: LibriVox Indonesia 1.0
+annotations_creators:
+- crowdsourced
+language_creators:
+- crowdsourced
+language:
+- ace
+- bal
+- bug
+- id
+- min
+- jav
+- sun
 license: cc
+multilinguality:
+- multilingual
+size_categories:
+  ace:
+  - 1K<n<10K
+  bal:
+  - 1K<n<10K
+  bug:
+  - 1K<n<10K
+  id:
+  - 1K<n<10K
+  min:
+  - 1K<n<10K
+  jav:
+  - 1K<n<10K
+  sun:
+  - 1K<n<10K
+source_datasets:
+- librivox
+task_categories:
+- speech-processing
+task_ids:
+- automatic-speech-recognition
 ---
+# Dataset Card for LibriVox Indonesia 1.0
+
+## 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://huggingface.co/datasets/indonesian-nlp/librivox-indonesia
+- **Repository:** https://huggingface.co/datasets/indonesian-nlp/librivox-indonesia
+- **Point of Contact:** [Cahya Wirawan](mailto:cahya.wirawan@gmail.com)
+
+### Dataset Summary
+The LibriVox Indonesia dataset consists of MP3 audio and a corresponding text file we generated from the public 
+domain audiobooks [LibriVox](https://librivox.org/). We collected only languages in Indonesia for this dataset. 
+The original LibriVox audiobooks or sound files' duration varies from a few minutes to a few hours. Each audio 
+file in the speech dataset now lasts from a few seconds to a maximum of 20 seconds. 
+
+We converted the audiobooks to speech datasets using the forced alignment software we developed. It supports 
+multilingual, including low-resource languages, such as Acehnese, Balinese, or Minangkabau. We can also use it 
+for other languages without additional work to train the model.
+
+The dataset currently consists of 8 hours in 7 languages from Indonesia. We will add more languages or audio files
+as we collect them.
+
+### Languages
+```
+Acehnese, Balinese, Bugisnese, Indonesian, Minangkabau, Javanese, Sundanese
+```
+
+## Dataset Structure
+### Data Instances
+A typical data point comprises the `path` to the audio file and its `sentence`. Additional fields include 
+`reader` and `language`.
+```python
+{
+  'path': 'librivox-indonesia/sundanese/universal-declaration-of-human-rights/human_rights_un_sun_brc_0000.mp3',
+  'language': 'sun',
+  'reader': '3174',
+  'sentence': 'pernyataan umum ngeunaan hak hak asasi manusa sakabeh manusa',
+  'audio': {
+    'path': 'librivox-indonesia/sundanese/universal-declaration-of-human-rights/human_rights_un_sun_brc_0000.mp3', 
+    'array': array([-0.00048828, -0.00018311, -0.00137329, ...,  0.00079346, 0.00091553,  0.00085449], dtype=float32), 
+    'sampling_rate': 44100
+  }, 
+}
+```
+
+### Data Fields
+`path` (`string`): The path to the audio file
+
+`language` (`string`): The language of the audio file
+
+`reader` (`string`): The reader Id in LibriVox
+
+`sentence` (`string`): The sentence the user read from the book.
+
+`audio` (`dict`): A dictionary containing the path to the downloaded 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 speech material has only train split.
+
+## Dataset Creation
+### Curation Rationale
+[Needs More Information]
+### Source Data
+#### Initial Data Collection and Normalization
+[Needs More Information]
+#### Who are the source language producers?
+[Needs More Information]
+### Annotations
+#### Annotation process
+[Needs More Information]
+#### Who are the annotators?
+[Needs More Information]
+### 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
+[More Information Needed] 
+## Additional Information
+### Dataset Curators
+[More Information Needed] 
+### Licensing Information
+Public Domain, [CC-0](https://creativecommons.org/share-your-work/public-domain/cc0/)
+### Citation Information
+```
+
+```

data/audio_test.tgz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6db6b18ab2183f8da63bec0e1b1093da570bd35d94bf78884a4629b49d09e839
+size 2800914

data/audio_train.tgz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7074b70fdb63702584170bdd8c50175c70fdd4188e88b3bcbf5ca93ebfe77735
+size 20763976

data/metadata_test.csv.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ae98aa3b9e0cc38953fab8fdfef3357681c3348e0328c80e61e0a2ca48aaf8c5
+size 1811

data/metadata_train.csv.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f44f0446d69fc159611f9da152d0a9dc2d3a6efd6e1081b5d10bf47813fc1eb3
+size 9360

languages.py

@@ -0,0 +1,10 @@
+LANGUAGES = {
+    'ace': 'Acehnese',
+    'bal': 'Balinese',
+    'bug': 'Bugisnese',
+    'id': 'Indonesian',
+    'min': 'Minangkabau',
+    'jav': 'Javanese',
+    'sun': 'Sundanese',
+    'all': 'All'
+}

librivox-indonesia.py

@@ -0,0 +1,168 @@
+# 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.
+""" LibriVox-Indonesia Dataset"""
+
+import csv
+import os
+
+import datasets
+from datasets.utils.py_utils import size_str
+
+from .languages import LANGUAGES
+from .release_stats import STATS
+
+_CITATION = """\
+"""
+
+_HOMEPAGE = "https://huggingface.co/indonesian-nlp/librivox-indonesia"
+
+_LICENSE = "https://creativecommons.org/publicdomain/zero/1.0/"
+
+_DATA_URL = "https://huggingface.co/datasets/cahya/librivox-indonesia/resolve/main/data"
+
+
+class LibriVoxIndonesiaConfig(datasets.BuilderConfig):
+    """BuilderConfig for LibriVoxIndonesia."""
+
+    def __init__(self, name, version, **kwargs):
+        self.language = kwargs.pop("language", None)
+        self.release_date = kwargs.pop("release_date", None)
+        self.num_clips = kwargs.pop("num_clips", None)
+        self.num_speakers = kwargs.pop("num_speakers", None)
+        self.validated_hr = kwargs.pop("validated_hr", None)
+        self.total_hr = kwargs.pop("total_hr", None)
+        self.size_bytes = kwargs.pop("size_bytes", None)
+        self.size_human = size_str(self.size_bytes)
+        description = (
+            f"LibriVox-Indonesia speech to text dataset in {self.language} released on {self.release_date}. "
+            f"The dataset comprises {self.validated_hr} hours of transcribed speech data"
+        )
+        super(LibriVoxIndonesiaConfig, self).__init__(
+            name=name,
+            version=datasets.Version(version),
+            description=description,
+            **kwargs,
+        )
+
+
+class LibriVoxIndonesia(datasets.GeneratorBasedBuilder):
+    DEFAULT_CONFIG_NAME = "all"
+
+    BUILDER_CONFIGS = [
+        LibriVoxIndonesiaConfig(
+            name=lang,
+            version=STATS["version"],
+            language=LANGUAGES[lang],
+            release_date=STATS["date"],
+            num_clips=lang_stats["clips"],
+            num_speakers=lang_stats["users"],
+            total_hr=float(lang_stats["totalHrs"]) if lang_stats["totalHrs"] else None,
+            size_bytes=int(lang_stats["size"]) if lang_stats["size"] else None,
+        )
+        for lang, lang_stats in STATS["locales"].items()
+    ]
+
+    def _info(self):
+        total_languages = len(STATS["locales"])
+        total_hours = self.config.total_hr
+        description = (
+            "LibriVox-Indonesia is a speech dataset generated from LibriVox with only languages from Indonesia."
+            f"The dataset currently consists of {total_hours} hours of speech "
+            f" in {total_languages} languages, but more voices and languages are always added."
+        )
+        features = datasets.Features(
+            {
+                "path": datasets.Value("string"),
+                "language": datasets.Value("string"),
+                "reader": datasets.Value("string"),
+                "sentence": datasets.Value("string"),
+                "audio": datasets.features.Audio(sampling_rate=44100)
+            }
+        )
+
+        return datasets.DatasetInfo(
+            description=description,
+            features=features,
+            supervised_keys=None,
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            citation=_CITATION,
+            version=self.config.version,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        dl_manager.download_config.ignore_url_params = True
+        audio_train = dl_manager.download(_DATA_URL + "/audio_train.tgz")
+        local_extracted_archive_train = dl_manager.extract(audio_train) if not dl_manager.is_streaming else None
+        audio_test = dl_manager.download(_DATA_URL + "/audio_test.tgz")
+        local_extracted_archive_test = dl_manager.extract(audio_test) if not dl_manager.is_streaming else None
+        path_to_clips = "librivox-indonesia"
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "local_extracted_archive": local_extracted_archive_train,
+                    "audio_files": dl_manager.iter_archive(audio_train),
+                    "metadata_path": dl_manager.download_and_extract(_DATA_URL + "/metadata_train.csv.gz"),
+                    "path_to_clips": path_to_clips,
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={
+                    "local_extracted_archive": local_extracted_archive_test,
+                    "audio_files": dl_manager.iter_archive(audio_test),
+                    "metadata_path": dl_manager.download_and_extract(_DATA_URL + "/metadata_test.csv.gz"),
+                    "path_to_clips": path_to_clips,
+                },
+            ),
+        ]
+
+    def _generate_examples(
+            self,
+            local_extracted_archive,
+            audio_files,
+            metadata_path,
+            path_to_clips,
+    ):
+        """Yields examples."""
+        print(metadata_path)
+        data_fields = list(self._info().features.keys())
+        metadata = {}
+        with open(metadata_path, "r", encoding="utf-8") as f:
+            reader = csv.DictReader(f)
+            for row in reader:
+                if self.config.name == "all" or self.config.name == row["language"]:
+                    row["path"] = os.path.join(path_to_clips, row["path"])
+                    # if data is incomplete, fill with empty values
+                    for field in data_fields:
+                        if field not in row:
+                            row[field] = ""
+                    metadata[row["path"]] = row
+        id_ = 0
+        print("example length = %d" % len(metadata))
+        # print(metadata)
+        for path, f in audio_files:
+            print(path)
+            if path in metadata:
+                result = dict(metadata[path])
+                # set the audio feature and the path to the extracted file
+                path = os.path.join(local_extracted_archive, path) if local_extracted_archive else path
+                result["audio"] = {"path": path, "bytes": f.read()}
+                result["path"] = path
+                yield id_, result
+                id_ += 1

release_stats.py

@@ -0,0 +1,25 @@
+STATS = {
+    "name": "Librivox-Indonesia",
+    "version": "1.0.0",
+    "date": "2022-09-04",
+    "locales": {
+        "ace": {'reportedSentences': 149, 'duration': 1, 'clips': 1, 'users': 416, 'size': 1,
+                'avgDurationSecs': 1, 'totalHrs': 1},
+        "bal": {'reportedSentences': 175, 'duration': 1, 'clips': 1, 'users': 416, 'size': 1,
+                'avgDurationSecs': 1, 'totalHrs': 1},
+        "bug": {'reportedSentences': 142, 'duration': 1, 'clips': 1, 'users': 416, 'size': 1,
+                'avgDurationSecs': 1, 'totalHrs': 1},
+        "id": {'reportedSentences': 6238, 'duration': 1, 'clips': 1, 'users': 416, 'size': 1,
+               'avgDurationSecs': 1, 'totalHrs': 1},
+        "min": {'reportedSentences': 156, 'duration': 1, 'clips': 1, 'users': 416, 'size': 1,
+                'avgDurationSecs': 1, 'totalHrs': 1},
+        "jav": {'reportedSentences': 801, 'duration': 1, 'clips': 1, 'users': 416, 'size': 1,
+                'avgDurationSecs': 1, 'totalHrs': 1},
+        "sun": {'reportedSentences': 154, 'duration': 1, 'clips': 1, 'users': 416, 'size': 1,
+                'avgDurationSecs': 1, 'totalHrs': 1},
+        "all": {'reportedSentences': 7815, 'duration': 1, 'clips': 1, 'users': 416, 'size': 1,
+                'avgDurationSecs': 1, 'totalHrs': 1},
+    },
+    'totalDuration': 1, 'totalHrs': 1
+}
+