Update README.md

README.md

@@ -26,3 +26,66 @@ configs:
   - split: test
     path: data/test-*
 ---
+
+
+# Wolof Audio Dataset
+
+The **Wolof Audio Dataset** is a collection of audio recordings and their corresponding transcriptions in Wolof. This dataset is designed to support the development of Automatic Speech Recognition (ASR) models for the Wolof language. It was created by combining two existing datasets:
+
+- **ALFFA**: Available at [serge-wilson/wolof_speech_transcription](https://huggingface.co/datasets/serge-wilson/wolof_speech_transcription)
+- **FLEURS**: Available at [vonewman/wo_fleurs_audio_transcription](https://huggingface.co/datasets/vonewman/wo_fleurs_audio_transcription)
+
+## Dataset Description
+
+- **Language**: Wolof (`wo`)
+- **Domain**: General speech
+- **Data Type**: Audio recordings and transcriptions
+- **Audio Format**: Varies (e.g., WAV, MP3)
+- **Sampling Rate**: 16 kHz
+- **Total Examples**: 24,346
+  - **Training Set**: 20,224 examples
+  - **Test Set**: 4,122 examples
+
+### Features
+
+- `audio`: An audio file containing speech in Wolof.
+  - **Format**: Varies (e.g., WAV, MP3)
+  - **Sampling Rate**: 16 kHz
+- `sentence`: The textual transcription of the audio in Wolof.
+- `source`: The origin of the example, either `'alffa'` or `'fleurs'`.
+
+### Dataset Structure
+
+#### Splits
+
+The dataset is divided into two splits:
+
+| Split  | Number of Examples |
+|--------|---------------------|
+| Train  | 20,224              |
+| Test   | 4,122               |
+
+## Usage Example
+
+Here's how to load and use this dataset with the 🤗 Datasets library:
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset("vonewman/wolof-audio-data")
+
+# Access an example from the 'train' split
+print(dataset['train'][0])
+
+# Expected output:
+# {
+#   'audio': {
+#     'path': '.../train/audio/<audio_file>',
+#     'array': array([...]),
+#     'sampling_rate': 16000
+#   },
+#   'sentence': 'Transcription of the audio in Wolof',
+#   'source': 'alffa'  # or 'fleurs'
+# }
+