perrynelson commited on
Commit
795ba0f
·
1 Parent(s): 858f9bb

Wipe batch 1

Browse files
Files changed (1) hide show
  1. README.md +0 -280
README.md DELETED
@@ -1,280 +0,0 @@
1
- ---
2
- license:
3
- - cc-by-sa-4.0
4
- - cc-by-nc-4.0
5
- - cc-by-4.0
6
- annotation_creators:
7
- - human-annotated
8
- - crowdsourced
9
- language_creators:
10
- - creator_1
11
- tags:
12
- - audio
13
- - automatic-speech-recognition
14
- - text-to-speech
15
- language:
16
- - ach
17
- - aka
18
- - dag
19
- - dga
20
- - ewe
21
- - fat
22
- - ful
23
- - hau
24
- - ibo
25
- - kpo
26
- - lin
27
- - lug
28
- - mas
29
- - mlg
30
- - nyn
31
- - sna
32
- - sog
33
- - swa
34
- - twi
35
- - yor
36
- multilinguality:
37
- - multilingual
38
- pretty_name: Waxal NLP Datasets
39
- task_categories:
40
- - automatic-speech-recognition
41
- - text-to-speech
42
- source_datasets:
43
- - UGSpeechData
44
- - DigitalUmuganda/AfriVoice
45
- - original
46
- configs:
47
- - config_name: asr
48
- data_files:
49
- - split: train
50
- path: "data/ASR/**/*-train-*"
51
- - split: validation
52
- path: "data/ASR/**/*-validation-*"
53
- - split: test
54
- path: "data/ASR/**/*-test-*"
55
- - split: unlabeled
56
- path: "data/ASR/**/*-unlabeled-*"
57
- - config_name: tts
58
- data_files:
59
- - split: train
60
- path: "data/TTS/**/*-train-*"
61
- - split: validation
62
- path: "data/TTS/**/*-validation-*"
63
- - split: test
64
- path: "data/TTS/**/*-test-*"
65
- dataset_info:
66
- - config_name: asr
67
- features:
68
- - name: id
69
- dtype: string
70
- - name: speaker_id
71
- dtype: string
72
- - name: transcription
73
- dtype: string
74
- - name: language
75
- dtype: string
76
- - name: gender
77
- dtype: string
78
- - name: audio
79
- dtype: audio
80
- - config_name: tts
81
- features:
82
- - name: id
83
- dtype: string
84
- - name: speaker_id
85
- dtype: string
86
- - name: transcription
87
- dtype: string
88
- - name: locale
89
- dtype: string
90
- - name: gender
91
- dtype: string
92
- - name: audio
93
- dtype: audio
94
- ---
95
-
96
- # Waxal Datasets
97
-
98
- ## Table of Contents
99
-
100
- - [Dataset Description](#dataset-description)
101
- - [ASR Dataset](#asr-dataset)
102
- - [TTS Dataset](#tts-dataset)
103
- - [How to Use](#how-to-use)
104
- - [Dataset Structure](#dataset-structure)
105
- - [ASR Data Fields](#asr-data-fields)
106
- - [TTS Data Fields](#tts-data-fields)
107
- - [Data Splits](#data-splits)
108
- - [Dataset Curation](#dataset-curation)
109
- - [Considerations for Using the Data](#considerations-for-using-the-data)
110
- - [Additional Information](#additional-information)
111
-
112
- ## Dataset Description
113
-
114
- The Waxal project provides datasets for both Automated Speech Recognition (ASR)
115
- and Text-to-Speech (TTS) for African languages. The goal of this dataset's
116
- creation and release is to facilitate research that improves the accuracy and
117
- fluency of speech and language technology for these underserved languages, and
118
- to serve as a repository for digital preservation.
119
-
120
- The Waxal datasets are collections acquired through partnerships with Makerere
121
- University, The University of Ghana, Digital Umuganda, and Media Trust.
122
- Acquisition was funded by Google and the Gates Foundation under an agreement to
123
- make the dataset openly accessible.
124
-
125
- ### ASR Dataset
126
-
127
- The Waxal ASR dataset is a collection of data in 14 African languages. It
128
- consists of approximately 1,250 hours of transcribed natural speech from a wide
129
- variety of voices. The 14 languages in this dataset represent over 100 million
130
- speakers across 40 Sub-Saharan African countries.
131
-
132
- Provider | Languages | License
133
- :------------------ | :--------------------------------------- | :------------:
134
- Makerere University | Acholi, Luganda, Masaaba, Nyankole, Soga | `CC-BY-4.0`
135
- University of Ghana | Akan, Ewe, Dagbani, Dagaare, Ikposo | `CC-BY-NC-4.0`
136
- Digital Umuganda | Fula, Lingala, Shona, Malagasy | `CC-BY-4.0`
137
-
138
- ### TTS Dataset
139
-
140
- The Waxal TTS dataset is a collection of text-to-speech data in 10 African
141
- languages. It consists of approximately 240 hours of scripted natural speech
142
- from a wide variety of voices.
143
-
144
- Provider | Languages | License
145
- :------------------ | :----------------------------------- | :------------:
146
- Makerere University | Acholi, Luganda, Kiswahili, Nyankole | `CC-BY-4.0`
147
- University of Ghana | Akan (Fante, Twi) | `CC-BY-NC-4.0`
148
- Media Trust | Fula, Igbo, Hausa, Yoruba | `CC-BY-4.0`
149
-
150
- ### How to Use
151
-
152
- The `datasets` library allows you to load and pre-process your dataset in pure
153
- Python, at scale.
154
-
155
- First, ensure you have the necessary dependencies installed to handle audio
156
- data:
157
-
158
- ```bash
159
- pip install datasets[audio]
160
- ```
161
-
162
- **Loading ASR Data**
163
-
164
- To load ASR data, point to the `data/ASR` directory.
165
-
166
- ```python
167
- from datasets import load_dataset, Audio
168
-
169
- # Load Shona (sna) ASR dataset
170
- asr_data = load_dataset("google/WaxalNLP", "sna", data_dir="data/ASR")
171
-
172
- # Access splits
173
- train = asr_data['train']
174
- val = asr_data['validation']
175
- test = asr_data['test']
176
-
177
- # Example: Accessing audio bytes and other fields
178
- example = train[0]
179
- print(f"Transcription: {example['transcription']}")
180
- print(f"Sampling Rate: {example['audio']['sampling_rate']}")
181
- # 'array' contains the decoded audio bytes as a numpy array
182
- print(f"Audio Array Shape: {example['audio']['array'].shape}")
183
- ```
184
-
185
- **Loading TTS Data**
186
-
187
- To load TTS data, point to the `data/TTS` directory.
188
-
189
- ```python
190
- from datasets import load_dataset
191
-
192
- # Load Swahili (swa) TTS dataset
193
- tts_data = load_dataset("google/WaxalNLP", "swa", data_dir="data/TTS")
194
-
195
- # Access splits
196
- train = tts_data['train']
197
- ```
198
-
199
- ## Dataset Structure
200
-
201
- ### ASR Data Fields
202
-
203
- ```python
204
- {
205
- 'id': 'sna_0',
206
- 'speaker_id': '...',
207
- 'audio': {
208
- 'array': [...],
209
- 'sample_rate': 16_000
210
- },
211
- 'transcription': '...',
212
- 'language': 'sna',
213
- 'gender': 'Female',
214
- }
215
- ```
216
-
217
- * **id**: Unique identifier.
218
- * **speaker_id**: Unique identifier for the speaker.
219
- * **audio**: Audio data.
220
- * **transcription**: Transcription of the audio.
221
- * **language**: ISO 639-2 language code.
222
- * **gender**: Speaker gender ('Male', 'Female', or empty).
223
-
224
- ### TTS Data Fields
225
-
226
- ```python
227
- {
228
- 'id': 'swa_0',
229
- 'speaker_id': '...',
230
- 'audio': {
231
- 'array': [...],
232
- 'sample_rate': 16_000
233
- },
234
- 'transcription': '...',
235
- 'locale': 'swa',
236
- 'gender': 'Female',
237
- }
238
- ```
239
-
240
- * **id**: Unique identifier.
241
- * **speaker_id**: Unique identifier for the speaker.
242
- * **audio**: Audio data.
243
- * **transcription**: Transcription.
244
- * **locale**: ISO 639-2 language code.
245
- * **gender**: Speaker gender.
246
-
247
- ### Data Splits
248
-
249
- For the **ASR Dataset**, the data with transcriptions is split as follows: *
250
- **train**: 80% of labeled data. * **validation**: 10% of labeled data. *
251
- **test**: 10% of labeled data.
252
-
253
- The **unlabeled** split contains all samples that do not have a corresponding
254
- transcription.
255
-
256
- The **TTS Dataset** follows a similar structure, with data split into `train`,
257
- `validation`, and `test` sets.
258
-
259
- ## Dataset Curation
260
-
261
- The data was gathered by multiple partners:
262
-
263
- Provider | Dataset | License
264
- :------------------ | :------------------------------------------------------- | :------
265
- University of Ghana | [UGSpeechData](https://doi.org/10.57760/sciencedb.22298) | `CC BY-NC-ND 4.0`
266
- Digital Umuganda | [AfriVoice](DigitalUmuganda/AfriVoice) | `CC-BY 4.0`
267
- Makerere University | [Yogera Dataset](https://doi.org/10.7910/DVN/BEROE0) | `CC-BY 4.0`
268
- Media Trust | | `CC-BY 4.0`
269
-
270
- ## Considerations for Using the Data
271
-
272
- Please check the license for the specific languages you are using, as they may
273
- differ between providers.
274
-
275
- **Affiliation:** Google Research
276
-
277
- ## Version and Maintenance
278
-
279
- - **Current Version:** 1.0.0
280
- - **Last Updated:** 01/2026