MadLook commited on
Commit
74c4618
·
verified ·
1 Parent(s): 7cd28d4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +169 -28
README.md CHANGED
@@ -1,30 +1,171 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: input_features
5
- sequence:
6
- sequence: float32
7
- - name: labels
8
- sequence: int64
9
- splits:
10
- - name: train
11
- num_bytes: 36341853032
12
- num_examples: 37835
13
- - name: validation
14
- num_bytes: 2524287408
15
- num_examples: 2628
16
- - name: test
17
- num_bytes: 2524301720
18
- num_examples: 2628
19
- download_size: 5837478573
20
- dataset_size: 41390442160
21
- configs:
22
- - config_name: default
23
- data_files:
24
- - split: train
25
- path: data/train-*
26
- - split: validation
27
- path: data/validation-*
28
- - split: test
29
- path: data/test-*
30
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ language:
3
+ - ar
4
+ license: apache-2.0
5
+ task_categories:
6
+ - automatic-speech-recognition
7
+ tags:
8
+ - whisper
9
+ - arabic
10
+ - speech
11
+ - asr
12
+ - multidialect
13
+ pretty_name: Arabic Whisper Multi-Dialect (Processed) - Small
14
+ size_categories:
15
+ - 10K<n<100K
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
  ---
17
+
18
+ # Arabic Whisper Multi-Dialect - Processed (Small)
19
+
20
+ ## Dataset Description
21
+
22
+ This is a **preprocessed** version of the Arabic multi-dialect speech dataset, ready for fine-tuning OpenAI's Whisper models. The dataset contains audio features extracted and formatted specifically for Whisper training.
23
+
24
+ - **Size**: 40% subset of the full `arabic-whisper-multidialect` dataset
25
+ - **Total Examples**: 43,091 samples
26
+ - **Format**: Pre-computed Whisper input features (mel spectrograms) and tokenized labels
27
+ - **Purpose**: Direct use with Whisper training pipelines without additional preprocessing
28
+
29
+ ### Key Features
30
+
31
+ ✅ **Pre-processed** - Audio already converted to Whisper input features
32
+ ✅ **Multi-dialect** - Covers various Arabic dialects
33
+ ✅ **Training-ready** - No additional feature extraction needed
34
+ ✅ **Memory-efficient** - Optimized for faster loading during training
35
+
36
+ ## Dataset Structure
37
+
38
+ ### Data Splits
39
+
40
+ | Split | Examples | Size (GB) |
41
+ |-------|----------|-----------|
42
+ | Train | 37,835 | 33.8 |
43
+ | Validation | 2,628 | 2.35 |
44
+ | Test | 2,628 | 2.35 |
45
+ | **Total** | **43,091** | **38.5** |
46
+
47
+ ### Data Fields
48
+
49
+ - **`input_features`**: `Sequence[Sequence[float32]]`
50
+ - Shape: `(80, 3000)` - 80 mel-frequency bins × 3000 time steps
51
+ - Pre-computed log-mel spectrogram features for Whisper
52
+
53
+ - **`labels`**: `Sequence[int64]`
54
+ - Tokenized Arabic transcription using Whisper's tokenizer
55
+ - Special tokens: `-100` for padding (ignored in loss computation)
56
+
57
+ ## Usage
58
+
59
+ ### Quick Start
60
+
61
+ ```python
62
+ from datasets import load_dataset
63
+
64
+ # Load the dataset
65
+ dataset = load_dataset("MadLook/arabic-whisper-multidialect-processed-small")
66
+
67
+ print(dataset)
68
+ # DatasetDict({
69
+ # train: Dataset with 37,835 examples
70
+ # validation: Dataset with 2,628 examples
71
+ # test: Dataset with 2,628 examples
72
+ # })
73
+ ```
74
+
75
+
76
+ ### Loading a Single Split
77
+
78
+ ```python
79
+ # Load only training data
80
+ train_data = load_dataset("MadLook/arabic-whisper-multidialect-processed-small", split="train")
81
+
82
+ # Load with streaming for large datasets
83
+ train_stream = load_dataset("MadLook/arabic-whisper-multidialect-processed-small", split="train", streaming=True)
84
+ ```
85
+
86
+ ## Preprocessing Details
87
+
88
+ This dataset was created from the original Arabic multi-dialect dataset using the following preprocessing pipeline:
89
+
90
+ 1. **Audio Loading**: Resampled to 16kHz mono audio
91
+ 2. **Feature Extraction**: Converted to 80-channel log-mel spectrograms using Whisper's feature extractor
92
+ 3. **Tokenization**: Arabic text transcriptions tokenized with Whisper's multilingual tokenizer
93
+ 4. **Normalization**: Applied Whisper's standard audio normalization
94
+ 5. **Subset Selection**: Selected 40% of the original dataset
95
+
96
+ ### Processing Code
97
+
98
+ ```python
99
+ from transformers import WhisperProcessor
100
+
101
+ processor = WhisperProcessor.from_pretrained("openai/whisper-small", language="ar", task="transcribe")
102
+
103
+ def prepare_dataset(batch):
104
+ # Load and resample audio
105
+ audio = batch["audio"]
106
+
107
+ # Compute input features
108
+ batch["input_features"] = processor.feature_extractor(
109
+ audio["array"],
110
+ sampling_rate=audio["sampling_rate"]
111
+ ).input_features[0]
112
+
113
+ # Tokenize transcription
114
+ batch["labels"] = processor.tokenizer(batch["transcription"]).input_ids
115
+
116
+ return batch
117
+ ```
118
+
119
+ ## Source Dataset
120
+
121
+ This is a processed subset of the Arabic multi-dialect speech recognition dataset, which includes recordings from various Arabic-speaking regions and dialects.
122
+
123
+ ## Intended Use
124
+
125
+ ### Primary Use Cases
126
+
127
+ - Fine-tuning Whisper models for Arabic speech recognition
128
+ - Research on multi-dialect Arabic ASR
129
+ - Benchmarking Arabic speech recognition systems
130
+ - Transfer learning for low-resource Arabic dialects
131
+
132
+ ### Out-of-Scope Use
133
+
134
+ - This dataset is **already preprocessed** - do not apply feature extraction again
135
+ - Not suitable for training non-Whisper architectures without re-processing
136
+
137
+ ## Limitations
138
+
139
+ - Only 40% of the full dataset (subset for faster experimentation)
140
+ - Pre-computed features are specific to Whisper architecture
141
+ - Fixed audio length (30 seconds max due to Whisper constraints)
142
+
143
+
144
+ ## Citation
145
+
146
+ If you use this dataset, please cite both this preprocessed version and the original source dataset:
147
+
148
+ ```bibtex
149
+ @dataset{arabic_whisper_multidialect_processed,
150
+ title={Arabic Whisper Multi-Dialect - Processed (Small)},
151
+ author={MadLook},
152
+ year={2025},
153
+ publisher={Hugging Face},
154
+ url={https://huggingface.co/datasets/MadLook/arabic-whisper-multidialect-processed-small}
155
+ }
156
+ ```
157
+
158
+ ## License
159
+
160
+ Apache 2.0
161
+
162
+ ## Contact
163
+
164
+ For questions or issues with this dataset, please open an issue on the dataset repository.
165
+
166
+ ---
167
+
168
+ **Dataset Version**: 1.0
169
+ **Last Updated**: 2024
170
+ **Preprocessor**: Whisper Feature Extractor (openai/whisper-small)
171
+ **Compatible Models**: openai/whisper-tiny, openai/whisper-base, openai/whisper-small, openai/whisper-medium, openai/whisper-large