Upload README.md with huggingface_hub

README.md

@@ -1,21 +1,55 @@
 ---
-dataset_info:
-  features:
-  - name: audio
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: filename
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 4368090112
-    num_examples: 32000
-  download_size: 4352013095
-  dataset_size: 4368090112
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+license: cc0-1.0
+task_categories:
+- automatic-speech-recognition
+language:
+- lb
+tags:
+- audio
+- speech
+- luxembourgish
+- synthetic
+size_categories:
+- 10K<n<100K
 ---
+
+# LOD_Maxine Dataset
+
+## Dataset Description
+
+LOD_Maxine is a Luxembourgish speech dataset containing audio recordings paired with transcriptions. The audio features a synthetic voice named Maxine reading example sentences from the LOD (Lëtzebuerger Online Dictionnaire) available at lod.lu.
+
+## Dataset Statistics
+
+- **Total samples**: ~32,000
+- **Language**: Luxembourgish (Lëtzebuergesch)
+- **Audio format**: WAV files
+- **Sample rate**: 22,050 Hz
+
+## Dataset Structure
+
+Each sample contains:
+- `audio`: Audio file in WAV format
+- `text`: Transcription text
+- `filename`: Original filename identifier
+
+## Example
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("ZLSCompLing/LOD_Maxine")
+
+# Access a sample
+sample = dataset[0]
+print(f"Text: {sample['text']}")
+# Audio can be accessed via sample['audio']
+```
+
+## License
+
+This dataset is released under the CC0 license - fully public domain with free use and no attribution required.
+
+## Contact
+
+For questions or issues regarding this dataset, please contact the repository maintainers.