Update README.md

README.md

@@ -30,21 +30,10 @@ task_ids:
   - [Dataset Summary](#dataset-summary)
   - [Supported Tasks](#supported-tasks-and-leaderboards)
   - [Languages](#languages)
+- [Usage](#usage)
 - [Dataset Structure](#dataset-structure)
-  - [Data Instances](#data-instances)
-  - [Data Fields](#data-instances)
   - [Data Splits](#data-instances)
-- [Dataset Creation](#dataset-creation)
-  - [Curation Rationale](#curation-rationale)
-  - [Source Data](#source-data)
-  - [Annotations](#annotations)
-  - [Personal and Sensitive Information](#personal-and-sensitive-information)
-- [Considerations for Using the Data](#considerations-for-using-the-data)
-  - [Social Impact of Dataset](#social-impact-of-dataset)
-  - [Discussion of Biases](#discussion-of-biases)
-  - [Other Known Limitations](#other-known-limitations)
 - [Additional Information](#additional-information)
-  - [Dataset Curators](#dataset-curators)
   - [Licensing Information](#licensing-information)
   - [Citation Information](#citation-information)
 
@@ -62,80 +51,63 @@ ASCEND (A Spontaneous Chinese-English Dataset) introduces a high-quality resourc
 
 ### Supported Tasks and Leaderboards
 
-[Needs More Information]
+Code-switching.
 
 ### Languages
 
 Chinese and English
 
-## Dataset Structure
-
-### Data Instances
+## Usage
 
-[Needs More Information]
+```
+import datasets
+dataset = datasets.load_dataset("CAiRE/ASCEND", "train") # split: "train", "validation", "test"
+```
 
-### Data Fields
+## Dataset Structure
 
-[Needs More Information]
+A typical data point comprises the path to the audio file, the loaded audio array, and its transcription. Additional fields include datapoint id, duration, language, speaker id, session id, and topic.
+
+```
+{
+	'id': '00000',
+	'path': '.cache/huggingface/datasets/downloads/extracted/f0b33b5266cd9452ee310eef3577cf7adb7f29aa54dbff74b9a8ee406a55d614/waves/ses1_spk17_L3818_9.3200_0.6400.wav',
+	'audio': {
+		'path': '.cache/huggingface/datasets/downloads/extracted/f0b33b5266cd9452ee310eef3577cf7adb7f29aa54dbff74b9a8ee406a55d614/waves/ses1_spk17_L3818_9.3200_0.6400.wav',
+		'array': array([0.00057983, 0.00073242, 0.00125122, ..., 0.00204468, 0.00250244,
+			0.00201416
+		], dtype = float32),
+		'sampling_rate': 16000
+	},
+	'transcription': '好的',
+	'duration': 0.6399999856948853,
+	'language': 'zh',
+	'original_speaker_id': 17,
+	'session_id': 1,
+	'topic': 'persona'
+}
+```
 
 ### Data Splits
 
-[Needs More Information]
-
-## Dataset Creation
-
-### Curation Rationale
-
-[Needs More Information]
-
-### Source Data
-
-#### Initial Data Collection and Normalization
-
-[Needs More Information]
-
-#### Who are the source language producers?
-
-[Needs More Information]
-
-### Annotations
-
-#### Annotation process
-
-[Needs More Information]
-
-#### Who are the annotators?
-
-[Needs More Information]
-
-### Personal and Sensitive Information
-
-[Needs More Information]
-
-## Considerations for Using the Data
-
-### Social Impact of Dataset
-
-[Needs More Information]
-
-### Discussion of Biases
-
-[Needs More Information]
-
-### Other Known Limitations
-
-[Needs More Information]
+Number of utterances: 9,869 train, 1,129 validation, and 1,315 test.
 
 ## Additional Information
 
-### Dataset Curators
-
-[Needs More Information]
+For comprehensive explanations, please check [our paper](https://arxiv.org/pdf/2112.06223.pdf).
 
 ### Licensing Information
 
-[Needs More Information]
+Creative Common Attribution Share-Alike 4.0 International (CC-BY-SA 4.0)
 
 ### Citation Information
 
-[Needs More Information]
+If you use our dataset, please cite us:
+
+```
+@inproceedings{lovenia2022ascend,
+  title={ASCEND: A Spontaneous Chinese-English Dataset for Code-switching in Multi-turn Conversation},
+  author={Lovenia, Holy and Cahyawijaya, Samuel and Winata, Genta Indra and Xu, Peng and Yan, Xu and Liu, Zihan and Frieske, Rita and Yu, Tiezheng and Dai, Wenliang and Barezi, Elham J and others},
+  booktitle={Proceedings of the 13th Language Resources and Evaluation Conference (LREC)},
+  year={2022}
+ ```