Add dataset card

README.md

@@ -1,27 +1,80 @@
----
-dataset_info:
-  features:
-  - name: audio
-    dtype:
-      audio:
-        sampling_rate: 16000
-  - name: original_sentence
-    dtype: string
-  - name: clean_sentence
-    dtype: string
-  - name: class_label
-    dtype: string
-  - name: info
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 41411374.69
-    num_examples: 2745
-  download_size: 29893158
-  dataset_size: 41411374.69
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
+# Ntkuhn/Mlx Voice Commands
+
+## Dataset Description
+
+This dataset contains audio commands with voice control labels generated using text-to-speech synthesis.
+
+### Dataset Summary
+
+- **Total samples**: 2745
+- **Number of classes**: 13
+- **Audio format**: MP3, 16kHz sampling rate
+- **Text-to-speech engine**: Google Text-to-Speech (gTTS)
+
+### Class Distribution
+
+| Class Label | Count |
+|-------------|--------|
+| <close_browser> | 201 |
+| <google> | 200 |
+| <maximize_window> | 307 |
+| <minimize_window> | 100 |
+| <mute> | 307 |
+| <no_action> | 100 |
+| <open_browser> | 200 |
+| <open_notepad> | 200 |
+| <play_music> | 207 |
+| <stop_music> | 206 |
+| <switch_window> | 100 |
+| <volume_down> | 309 |
+| <volume_up> | 308 |
+
+### Dataset Structure
+
+#### Data Fields
+
+- `audio` (Audio): Audio file containing the spoken command
+- `original_sentence` (string): Original sentence with special tokens
+- `clean_sentence` (string): Clean sentence without special tokens (used for TTS)
+- `class_label` (string): Command class label (e.g., `<volume_up>`, `<volume_down>`)
+- `info` (string): Additional information about the audio generation
+
+#### Example
+
+```python
+{
+    'audio': {'path': 'audio_0001_volume_up_16k.mp3', 'array': [...], 'sampling_rate': 16000},
+    'original_sentence': 'Please <volume_up> the music',
+    'clean_sentence': 'Please the music',
+    'class_label': '<volume_up>',
+    'info': 'gTTS, 16kHz mp3'
+}
+```
+
+### Usage
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset("ntkuhn/mlx_voice_commands")
+
+# Access audio and labels
+for sample in dataset["train"]:
+    audio = sample["audio"]
+    label = sample["class_label"]
+    clean_text = sample["clean_sentence"]
+    print(f"Label: {label}, Text: {clean_text}")
+```
+
+### Dataset Creation
+
+This dataset was created using the `generate_audio.py` script, which:
+1. Processes command sentences containing special tokens
+2. Removes special tokens to create clean sentences
+3. Generates audio using Google Text-to-Speech (gTTS)
+4. Resamples audio to 16kHz for consistency
+
+### Licensing
+
+Please refer to the original dataset license and Google's terms of service for gTTS usage.