Update README.md

README.md

@@ -59,4 +59,50 @@ size_categories:
 # Dataset Summary
 
 This dataset is a modified version of the ASCEND dataset which consists of spontaneous Mandarin-English code-switched speech. The ASCEND dataset was published by Lovenia et al. (2022) (Check [here](https://huggingface.co/datasets/CAiRE/ASCEND) for the dataset and [here](https://arxiv.org/pdf/2112.06223v6) for the paper). 
-This dataset adds a phonetic transcription column to the dataset using the eSpeak backend from the phonemizer library created by Bernard et al. (2021) (Check it out [here](https://github.com/bootphon/phonemizer)).
+This dataset adds a phonetic transcription column to the dataset using the eSpeak backend from the phonemizer library created by Bernard et al. (2021) (Check it out [here](https://github.com/bootphon/phonemizer)).
+
+
+## the following documentation is a modified version of the ASCEND [documentation](https://huggingface.co/datasets/CAiRE/ASCEND)
+
+# Usage
+
+To use the full dataset, run this:
+
+```
+from datasets import load_dataset
+
+ds = load_dataset("katyayego/ASCEND-phoneme")
+```
+
+# Dataset Structure
+
+A typical data point comprises the path to the audio file, the loaded audio array, and its transcription and phonetic transcription. Additional fields include datapoint id, duration, language, speaker id, session id, and topic.
+
+
+```
+{
+  'id': '00644',
+  'path': 'example_path.wav',
+  'audio': {
+      'path': 'example_audio.wav',
+      'array': array([-0.00320435, -0.00296021, -0.00039673, ...,  0.00198364,
+        0.00158691, -0.00061035]),
+          'sampling_rate': 16000
+  },
+  'transcription': '我们应该去帮助他们说',
+  'duration': 2.119999885559082,
+  'language': 'zh',
+  'original_speaker_id': 9,
+  'session_id': 3,
+  'topic': 'technology',
+  'phonetic_trans': 'w o2 m ə1 n j i5 ŋ k ai5 tɕh y5 p a5 ŋ ts. u5 th ɑ5 m ə1 n s. w o5'
+}
+```
+
+# Data Splits
+
+Number of utterances: 9,869 train, 1,130 validation, and 1,315 test.
+
+# Licensing Information
+
+Creative Common Attribution Share-Alike 4.0 International (CC-BY-SA 4.0)