urtzai commited on
Commit
f27799f
·
verified ·
1 Parent(s): a92f52b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -19
README.md CHANGED
@@ -15,6 +15,7 @@ tags:
15
  - Aholab
16
  - Ilenia
17
  - synthetic
 
18
  base_model:
19
  - itzune/maider-tts
20
  ---
@@ -23,19 +24,17 @@ base_model:
23
 
24
  This is a large-scale **synthetic speech corpus** designed for training and fine-tuning Basque Text-to-Speech (TTS) models. It consists of **99,996 audio files** synthesized from the "Maider" voice model.
25
 
26
- This dataset was generated by **Itzune** and serves as the primary source for training the [itzune/maider-tts (Piper version)](https://huggingface.co/itzune/maider-tts) model, enabling high-quality Basque synthesis in edge-compatible formats.
27
 
28
  ## Dataset Structure
29
 
30
  Due to the large volume of data (approx. 100,000 files), the dataset is organized in the **WebDataset** format. The audio files are bundled into `.tar` shards to optimize storage, I/O performance, and streaming.
31
 
32
-
33
-
34
  ### Files
35
- - **data/**: Directory containing the `.tar` shards. Each shard contains approximately 1,000 audio samples.
36
- - **metadata.csv**: The main metadata file using `|` as a delimiter. It follows this structure:
37
  - `file_name`: The name of the audio file (e.g., `audio_1.wav`).
38
- - `transcription`: The corresponding Basque text used for synthesis.
39
 
40
  ## Technical Specifications
41
 
@@ -43,38 +42,41 @@ Due to the large volume of data (approx. 100,000 files), the dataset is organize
43
  - **Sample Rate:** 22050 Hz
44
  - **Language:** Basque (eu)
45
  - **Voice Profile:** Maider (Female)
46
- - **Total Samples:** 99,996
47
  - **Generation Method:** Synthesized using VITS-based architecture.
48
 
49
  ## Usage
50
 
51
- You can load this dataset using the Hugging Face `datasets` library. Using `streaming=True` is highly recommended to avoid downloading the entire 100k files at once:
52
-
53
  ```python
54
  from datasets import load_dataset
55
 
56
  dataset = load_dataset("itzune/maider-dataset", streaming=True)
57
-
58
- # View an example
59
  sample = next(iter(dataset["train"]))
60
  print(f"Text: {sample['transcription']}")
61
  ```
62
 
63
  ## Credits and Licensing
64
-
65
  ### Source and Methodology
66
- This is a **synthetic dataset** generated by **Itzune**. It was created using the `aHoTTS` synthesis tools provided by **HiTZ Basque Center for Language Technology - Aholab Signal Processing Laboratory**.
67
 
68
- The audio files were synthesized using the pre-trained **Maider (VITS)** model, following the methodology described in the HiTZ/Aholab repository. This dataset serves as a large-scale synthetic corpus for downstream tasks, such as exporting models to edge-compatible formats (e.g., Piper).
 
 
 
 
69
 
70
  ### Acknowledgments
71
- The underlying technology and the original voice models were developed by:
72
- - **HiTZ Basque Center for Language Technology - Aholab Signal Processing Laboratory**, University of the Basque Country (UPV/EHU).
73
- - **Project ILENIA:** The Maider voice resource was developed with funding from Project ILENIA.
 
 
 
74
 
75
  ### License
76
- - **Dataset Content:** Licensed under [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).
77
- - **Original Tools/Code:** The tools used to generate this data are licensed under the **Apache License 2.0** by the original authors.
 
 
78
 
79
  ## Citation
80
  If you use this dataset, please cite the original work from HiTZ/Aholab:
 
15
  - Aholab
16
  - Ilenia
17
  - synthetic
18
+ - common-voice
19
  base_model:
20
  - itzune/maider-tts
21
  ---
 
24
 
25
  This is a large-scale **synthetic speech corpus** designed for training and fine-tuning Basque Text-to-Speech (TTS) models. It consists of **99,996 audio files** synthesized from the "Maider" voice model.
26
 
27
+ This dataset was generated by **Itzune** and serves as the primary source for training the [itzune/maider-tts (Piper version)](https://huggingface.co/itzune/maider-tts) model.
28
 
29
  ## Dataset Structure
30
 
31
  Due to the large volume of data (approx. 100,000 files), the dataset is organized in the **WebDataset** format. The audio files are bundled into `.tar` shards to optimize storage, I/O performance, and streaming.
32
 
 
 
33
  ### Files
34
+ - **data/**: Directory containing the `.tar` shards.
35
+ - **metadata.csv**: The main metadata file using `|` as a delimiter:
36
  - `file_name`: The name of the audio file (e.g., `audio_1.wav`).
37
+ - `transcription`: The corresponding Basque text.
38
 
39
  ## Technical Specifications
40
 
 
42
  - **Sample Rate:** 22050 Hz
43
  - **Language:** Basque (eu)
44
  - **Voice Profile:** Maider (Female)
45
+ - **Text Source:** [Mozilla Common Voice - Basque Sentence Collection](https://datacollective.mozillafoundation.org/datasets/cmj8u3p2v007tnxxbk5ng5qvh)
46
  - **Generation Method:** Synthesized using VITS-based architecture.
47
 
48
  ## Usage
49
 
 
 
50
  ```python
51
  from datasets import load_dataset
52
 
53
  dataset = load_dataset("itzune/maider-dataset", streaming=True)
 
 
54
  sample = next(iter(dataset["train"]))
55
  print(f"Text: {sample['transcription']}")
56
  ```
57
 
58
  ## Credits and Licensing
 
59
  ### Source and Methodology
 
60
 
61
+ This is a synthetic dataset generated by Itzune. The synthesis process involved:
62
+
63
+ - **Text Acquisition**: Sentences were sourced from the Mozilla Common Voice project (Basque sentence collection).
64
+
65
+ - **Audio Synthesis**: The audio was produced using the aHoTTS synthesis tools and the pre-trained Maider (VITS) model developed by HiTZ Basque Center for Language Technology - Aholab Signal Processing Laboratory.
66
 
67
  ### Acknowledgments
68
+
69
+ Mozilla Common Voice: For providing the community-driven sentence collection.
70
+
71
+ HiTZ Basque Center for Language Technology - Aholab Signal Processing Laboratory: For the underlying synthesis technology and the Maider voice model.
72
+
73
+ Project ILENIA: The original Maider voice resource was developed with funding from Project ILENIA.
74
 
75
  ### License
76
+
77
+ Dataset Content (Audio & Text): Licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
78
+
79
+ Original Tools/Code: The aHoTTS tools used to generate this data are licensed under the Apache License 2.0.
80
 
81
  ## Citation
82
  If you use this dataset, please cite the original work from HiTZ/Aholab: