carlosdanielhernandezmena commited on
Commit
1ce6b6f
1 Parent(s): 1a180fc

Adding information to the README file

Browse files
Files changed (1) hide show
  1. README.md +188 -0
README.md CHANGED
@@ -31,4 +31,192 @@ configs:
31
  - split: train
32
  path: voxforge_spanish/train-*
33
  default: true
 
 
 
 
 
 
 
 
 
 
 
 
 
34
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
  - split: train
32
  path: voxforge_spanish/train-*
33
  default: true
34
+ task_categories:
35
+ - automatic-speech-recognition
36
+ language:
37
+ - es
38
+ tags:
39
+ - voxforge spanish
40
+ - read speech
41
+ - ciempiess-unam project
42
+ - ciempiess
43
+ - spanish speech
44
+ pretty_name: VOXFORGE SPANISH CORPUS
45
+ size_categories:
46
+ - 10K<n<100K
47
  ---
48
+
49
+ # Dataset Card for voxforge_spanish
50
+ ## Table of Contents
51
+ - [Dataset Description](#dataset-description)
52
+ - [Dataset Summary](#dataset-summary)
53
+ - [Supported Tasks](#supported-tasks-and-leaderboards)
54
+ - [Languages](#languages)
55
+ - [Dataset Structure](#dataset-structure)
56
+ - [Data Instances](#data-instances)
57
+ - [Data Fields](#data-fields)
58
+ - [Data Splits](#data-splits)
59
+ - [Dataset Creation](#dataset-creation)
60
+ - [Curation Rationale](#curation-rationale)
61
+ - [Source Data](#source-data)
62
+ - [Annotations](#annotations)
63
+ - [Personal and Sensitive Information](#personal-and-sensitive-information)
64
+ - [Considerations for Using the Data](#considerations-for-using-the-data)
65
+ - [Social Impact of Dataset](#social-impact-of-dataset)
66
+ - [Discussion of Biases](#discussion-of-biases)
67
+ - [Other Known Limitations](#other-known-limitations)
68
+ - [Additional Information](#additional-information)
69
+ - [Dataset Curators](#dataset-curators)
70
+ - [Licensing Information](#licensing-information)
71
+ - [Citation Information](#citation-information)
72
+ - [Contributions](#contributions)
73
+
74
+ ## Dataset Description
75
+ - **Homepage:** [CIEMPIESS-UNAM Project](https://ciempiess.org/)
76
+ - **Repository:** [VOXFORGE SPANISH CORPUS at HuggingFace](https://huggingface.co/datasets/ciempiess/voxforge_spanish)
77
+ - **Point of Contact:** [Carlos Mena](mailto:[email protected])
78
+
79
+ ### Dataset Summary
80
+
81
+ [VoxForge](https://www.voxforge.org/) was set up to collect transcribed speech for use with Free and Open Source Speech Recognition Engines (on Linux, Windows and Mac). They promise they will make available all submitted audio files under the GPL license, and then 'compile' them into acoustic models for use with Open Source speech recognition engines such as CMU Sphinx, ISIP, Julius and HTK. According to this, we downloaded the Spanish recordings of Voxforge in 2016 to create the VOXFORGE SPANISH CORPUS.
82
+
83
+ The VOXFORGE SPANISH CORPUS has a duration of 49 hours and it is constituted by read speech recorded by more than 2 thousand speakers. Most of the speakers contribute with 10 recordings of approximately 10 seconds of duration each. Data is divided by speaker, by gender (male/female) and also by country (Argentina/Chile/LatinAmerica/Mexico/Spain/Unknown).
84
+
85
+ ### Example Usage
86
+ The VOXFORGE SPANISH CORPUS contains only the train split:
87
+
88
+ ```python
89
+ from datasets import load_dataset
90
+ voxforge_spanish = load_dataset("ciempiess/voxforge_spanish")
91
+ ```
92
+ It is also valid to do:
93
+ ```python
94
+ from datasets import load_dataset
95
+ voxforge_spanish = load_dataset("ciempiess/voxforge_spanish",split="train")
96
+ ```
97
+
98
+ ### Supported Tasks
99
+ automatic-speech-recognition: The dataset can be used to test a model for Automatic Speech Recognition (ASR). The model is presented with an audio file and asked to transcribe the audio file to written text. The most common evaluation metric is the word error rate (WER).
100
+
101
+ ### Languages
102
+ The language of the corpus is Spanish.
103
+
104
+ ## Dataset Structure
105
+
106
+ ### Data Instances
107
+ ```python
108
+ {
109
+ 'audio_id': 'VXSP_F_0019_ARG_0033',
110
+ 'audio': {
111
+ 'path': '/home/carlos/.cache/HuggingFace/datasets/downloads/extracted/7486eaf05a10c7554cd5de3d32c720fa206d11ad5f76e7f277553b34b1fbb58b/argentina/female/F_0019/VXSP_F_0019_ARG_0033.flac',
112
+ 'array': array([-0.01412964, -0.02548218, -0.00692749, ..., -0.03274536,
113
+ -0.03857422, -0.03134155], dtype=float32), 'sampling_rate': 16000
114
+ },
115
+ 'speaker_id': 'F_0019',
116
+ 'country': 'argentina',
117
+ 'gender': 'female',
118
+ 'duration': 11.5,
119
+ 'normalized_text': 'todo estaba lo mismo que una hora antes cuando el té humeaba en la taza de ojeda ahora vacía y blanqueaban sobre la mesa los pliegos'
120
+ }
121
+ ```
122
+
123
+ ### Data Fields
124
+ * `audio_id` (string) - id of audio segment
125
+ * `audio` (datasets.Audio) - a dictionary containing the path to the audio, the decoded audio array, and the sampling rate. In non-streaming mode (default), the path points to the locally extracted audio. In streaming mode, the path is the relative path of an audio inside its archive (as files are not downloaded and extracted locally).
126
+ * `speaker_id` (string) - id of speaker
127
+ * `country` (string) - country of birth of the speaker.
128
+ * `gender` (string) - gender of speaker (male or female)
129
+ * `duration` (float32) - duration of the audio file in seconds.
130
+ * `normalized_text` (string) - normalized audio segment transcription
131
+
132
+ ### Data Splits
133
+
134
+ The corpus counts just with the train split which has a total of 21692 speech files from 467 female speakers and 1713 male speakers with a total duration of 49 hours and 42 minutes.
135
+
136
+ ## Dataset Creation
137
+
138
+ ### Curation Rationale
139
+
140
+ The VOXFORGE SPANISH CORPUS (VSC) has the following characteristics:
141
+
142
+ * The VSC has an exact duration of 49 hours and 42 minutes. It has 21692 audio files. 17053 of those files come from male speakers and 4639 come from female speakers. All recordings come from read speech.
143
+
144
+ * Male speakers contribute with 39h16m56s and female speakers contribute with 10h25m53s.
145
+
146
+ * The VSC counts with 2180 different speakers: 1713 men and 467 women.
147
+
148
+ * Every audio file in the VSC has a duration of 10 seconds approximately. Almost every speaker contributes with 10 recordings.
149
+
150
+ * Data in VSC is classified by speaker. It means, all the recordings of one single speaker are stored in one single directory.
151
+
152
+ * Data is also classified according to the gender (male/female) of the speakers and according to the nationality of the speaker (Argentina/Chile/LatinAmerica/Mexico/Spain/Unknown).
153
+
154
+ * Audio files in the VSC are distributed in a 16khz@16bit mono format.
155
+
156
+ * Information of an specific speaker can be tracked using the "Speaker_Info.xls" file to locate the Voxforge user name of that speaker and then, that user can be located in the Voxforge website.
157
+
158
+ * Every audio file has an ID that is compatible with ASR engines such as Kaldi and CMU-Sphinx.
159
+
160
+ ### Source Data
161
+
162
+ #### Initial Data Collection and Normalization
163
+
164
+ The VOXFORGE SPANISH CORPUS is a speech corpus designed to train acoustic models for automatic speech recognition and it is made out of recordings taken from [VoxForge](https://www.voxforge.org/).
165
+
166
+ ### Annotations
167
+
168
+ #### Annotation process
169
+
170
+ The annotation process is at follows:
171
+
172
+ * 1. A whole podcast is manually segmented keeping just the portions containing good quality speech.
173
+ * 2. A second pass os segmentation is performed; this time to separate speakers and put them in different folders.
174
+ * 3. The resulting speech files between 5 and 10 seconds are transcribed by students from different departments (computing, engineering, linguistics). Most of them are native speakers but not with a particular training as transcribers.
175
+
176
+ #### Who are the annotators?
177
+
178
+ The VOXFORGE SPANISH CORPUS was created under the umbrella of the social service program ["Desarrollo de Tecnologías del Habla"](http://profesores.fi-b.unam.mx/carlos_mena/servicio.html) of the ["Facultad de Ingeniería"](https://www.ingenieria.unam.mx/) (FI) in the ["Universidad Nacional Autónoma de México"](https://www.unam.mx/) (UNAM) between 2016 and 2017 by Carlos Daniel Hernández Mena, head of the program.
179
+
180
+ ### Personal and Sensitive Information
181
+
182
+ The dataset could contain names revealing the identity of some speakers; on the other side, the recordings come from publicly available podcasts, so, there is not a real intent of the participants to be anonymized. Anyway, you agree to not attempt to determine the identity of speakers in this dataset.
183
+
184
+ ## Considerations for Using the Data
185
+
186
+ ### Social Impact of Dataset
187
+
188
+ This dataset is valuable because it contains well pronounced speech with low noise.
189
+
190
+ ### Discussion of Biases
191
+
192
+ The dataset is not gender balanced. It is comprised of 467 female speakers and 1713 male speakers.
193
+
194
+ ### Other Known Limitations
195
+
196
+ VOXFORGE SPANISH CORPUS by Carlos Daniel Hernández Mena is licensed under a [GPLv3](https://www.gnu.org/licenses/gpl.txt) license and it utilizes material from [Voxforge](http://www.voxforge.org). This work was done with the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
197
+
198
+ ### Dataset Curators
199
+
200
+ The dataset was collected by students belonging to the social service program ["Desarrollo de Tecnologías del Habla"](http://profesores.fi-b.unam.mx/carlos_mena/servicio.html). It was curated by [Carlos Daniel Hernández Mena](https://huggingface.co/carlosdanielhernandezmena) in 2017.
201
+
202
+ ### Licensing Information
203
+ [GPLv3](https://www.gnu.org/licenses/gpl.txt)
204
+
205
+ ### Citation Information
206
+ ```
207
+ @misc{carlosmena2017voxforgespanish,
208
+ title={VOXFORGE SPANISH CORPUS: Audio and Transcriptions taken from Voxforge.org},
209
+ author={Hernandez Mena, Carlos Daniel},
210
+ organization={CIEMPIESS-UNAM Project},
211
+ year={2017},
212
+ url={https://huggingface.co/datasets/ciempiess/voxforge_spanish},
213
+ }
214
+ ```
215
+
216
+ ### Contributions
217
+
218
+ The author would like to thank to Alejandro V. Mena, Elena Vera and Angélica Gutiérrez for their support to the social service program: "Desarrollo de Tecnologías del Habla." He also thanks to the social service students for all the hard work.
219
+
220
+ Special thanks to the VOXFORGE Team for publishing all the recordings that constitute the VOXFORGE SPANISH CORPUS.
221
+
222
+ This dataset card was created as part of the objectives of the 16th edition of the Severo Ochoa Mobility Program (PN039300 - Severo Ochoa 2021 - E&T).