Update README.md

README.md

@@ -1,35 +1,108 @@
----
-license: mit
-dataset_info:
-  features:
-  - name: file_name
-    dtype: string
-  - name: text
-    dtype: string
-  - name: audio
-    dtype:
-      audio:
-        sampling_rate: 16000
-  - name: duration
-    dtype: float64
-  - name: sample_rate
-    dtype: int64
-  - name: __index_level_0__
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 4847435436.0
-    num_examples: 2527
-  - name: test
-    num_bytes: 1213623320.0
-    num_examples: 632
-  download_size: 5634163911
-  dataset_size: 6061058756.0
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
----
+---
+license: mit
+dataset_info:
+  features:
+  - name: file_name
+    dtype: string
+  - name: text
+    dtype: string
+  - name: audio
+    dtype:
+      audio:
+        sampling_rate: 16000
+  - name: duration
+    dtype: float64
+  - name: sample_rate
+    dtype: int64
+  - name: __index_level_0__
+    dtype: int64
+  splits:
+  - name: train
+    num_bytes: 4847435436.0
+    num_examples: 2527
+  - name: test
+    num_bytes: 1213623320.0
+    num_examples: 632
+  download_size: 5634163911
+  dataset_size: 6061058756.0
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-*
+  - split: test
+    path: data/test-*
+---
+
+
+# Omarrran/dr_andrew_Huberman_eng_tts_hf_dataset
+
+## Dataset Description
+
+This dataset contains English text-to-speech (TTS) data, including paired text and audio files.
+
+## Dataset Statistics
+
+- Total number of samples: 3159
+- Number of samples in train split: 2527
+- Number of samples in test split: 632
+
+### Audio Statistics
+
+- Total audio duration: 31563.23 seconds (8.77 hours)
+- Average audio duration: 9.99 seconds
+- Minimum audio duration: 1.09 seconds
+- Maximum audio duration: 10.00 seconds
+
+### Text Statistics
+
+- Total number of words: 110645
+- Average number of words per sample: 35.03
+- Minimum number of words in a sample: 0
+- Maximum number of words in a sample: 74
+
+## Dataset Structure
+
+The dataset contains the following fields:
+
+- `file_name`: Value(dtype='string', id=None)
+- `text`: Value(dtype='string', id=None)
+- `audio`: Audio(sampling_rate=16000, mono=True, decode=True, id=None)
+- `duration`: Value(dtype='float64', id=None)
+- `sample_rate`: Value(dtype='int64', id=None)
+- `__index_level_0__`: Value(dtype='int64', id=None)
+
+## Usage Example
+
+Here's a simple example of how to load and use this dataset:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset('Omarrran/dr_andrew_Huberman_eng_tts_hf_dataset')
+
+# Access the training split
+train_data = dataset['train']
+
+# Get the first sample
+first_sample = train_data[0]
+print(f"Text: {first_sample['text']}")
+print(f"Audio file: {first_sample['audio']}")
+```
+
+## License
+
+Please refer to the dataset card for license information.
+
+## Citation
+
+If you use this dataset in your research, please cite it as follows:
+
+```
+@dataset{english_tts_hf_dataset,
+  author = {Haq Nawaz Malik},
+  title = {Omarrran/dr_andrew_Huberman_eng_tts_hf_dataset},
+  year = {2023},
+  url = {https://huggingface.co/datasets/Omarrran/dr_andrew_Huberman_eng_tts_hf_dataset}
+}
+```