Update README.md

README.md

@@ -1,33 +1,138 @@
+[![Datasets](https://img.shields.io/badge/dataset-MDCC-blue)](https://huggingface.co/datasets/ming030890/mdcc)
+
+# MDCC: A New Cantonese ASR Dataset
+
+## 📦 Update [1 Feb, 2024]
+
+The `.wav` data of the dataset is available here:  
+🔗 [Google Drive Link](https://drive.google.com/file/d/1epfYMMhXdBKA6nxPgUugb2Uj4DllSxkn/view?usp=drive_link)  
+**Note:** For research purposes only.
+
 ---
-dataset_info:
-  features:
-  - name: sex
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: transcript
-    dtype: string
-  - name: audio
-    dtype: audio
-  splits:
-  - name: train
-    num_bytes: 12858581773.6
-    num_examples: 65120
-  - name: validation
-    num_bytes: 1154465218.2
-    num_examples: 5663
-  - name: test
-    num_bytes: 2621750086.708
-    num_examples: 12492
-  download_size: 14739310268
-  dataset_size: 16634797078.508001
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: validation
-    path: data/validation-*
-  - split: test
-    path: data/test-*
+
+## 📖 Overview
+
+MDCC (“**M**ulti-**D**omain **C**antonese **C**orpus”) is a large-scale Cantonese automatic speech recognition (ASR) dataset compiled from multiple domains. It provides:
+
+- **Audio**: `.wav` recordings of spontaneous and read speech  
+- **Transcript**: UTF‑8 plain‑text transcripts  
+- **Speaker metadata**: sex  
+- **Duration**: audio length in seconds
+
+This repo contains metadata files and a conversion script to turn the data into a Hugging Face-compatible dataset.
+
 ---
+
+## 📝 Paper & Citation
+
+Tiezheng Yu, Rita Frieske, Peng Xu, Samuel Cahyawijaya, Cheuk Tung Shadow Yiu, Holy Lovenia,  
+Wenliang Dai, Elham J. Barezi, Qifeng Chen, Xiaojuan Ma, Bertram E. Shi & Pascale Fung  
+**“Automatic Speech Recognition Datasets in Cantonese: A Survey and New Dataset”**  
+📄 [arXiv:2201.02419](https://arxiv.org/pdf/2201.02419.pdf)
+
+```bibtex
+@misc{yu2022automatic,
+  title        = {Automatic Speech Recognition Datasets in Cantonese: A Survey and New Dataset},
+  author       = {Tiezheng Yu and Rita Frieske and Peng Xu and Samuel Cahyawijaya and
+                  Cheuk Tung Shadow Yiu and Holy Lovenia and Wenliang Dai and
+                  Elham J. Barezi and Qifeng Chen and Xiaojuan Ma and
+                  Bertram E. Shi and Pascale Fung},
+  year         = {2022},
+  eprint       = {2201.02419},
+  archivePrefix= {arXiv},
+  primaryClass = {cs.CL}
+}
+```
+
+---
+
+## 📂 Repository Contents
+
+```
+.
+├── cnt_asr_train_metadata.csv
+├── cnt_asr_valid_metadata.csv
+├── cnt_asr_test_metadata.csv
+├── audio/              # .wav files
+├── transcription/      # .txt transcripts
+├── dataset_conversion.py
+└── README.md
+```
+
+CSV columns:
+- `audio_path` → renamed to `audio`
+- `text_path`  → loaded into `transcript` and then dropped
+- `sex` → speaker gender
+- `duration` → in seconds
+
+---
+
+## 🚀 How to Load on Hugging Face
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("ming030890/mdcc")
+print(ds["train"][0])
+```
+
+Example output:
+```python
+{
+  'audio': {
+    'path': '/path/to/audio.wav',
+    'array': [...],
+    'sampling_rate': 16000
+  },
+  'transcript': '你好，歡迎收聽…',
+  'sex': 'female',
+  'duration': 3.08
+}
+```
+
+---
+
+## 🛠️ Running the Conversion Script
+
+1. Install dependencies:
+   ```bash
+   pip install datasets huggingface_hub pandas
+   ```
+
+2. Export your Hugging Face token:
+   ```bash
+   export HUGGINGFACE_HUB_TOKEN=<your_token>
+   ```
+
+3. Run the script:
+   ```bash
+   python dataset_conversion.py
+   ```
+
+This will prepare the dataset and upload it to `ming030890/mdcc` on Hugging Face.
+
+---
+
+## 🔓 License & Access
+
+1. Review the `MDCC_LICENSE` file in this repo.
+2. Sign it and send to **chinatysonyu@gmail.com**.
+3. Then download the dataset here:  
+   🔗 [Google Drive Folder](https://drive.google.com/drive/folders/1HhNqrPpUTtjsJ0wZQCSKqet7ftmWb6eI?usp=sharing)
+
+---
+
+## ✅ Checkpoints
+
+Download pretrained models here:  
+🔗 [Checkpoints Google Drive](https://drive.google.com/drive/folders/1BpGGOfr4IDYv0cWTowsDKkVmud7tNYzy?usp=sharing)
+
+---
+
+## ⚠️ Disclaimer
+
+I am **not the original author** of the dataset or the research paper.  
+This repo only provides a Hugging Face-compatible version of the public MDCC data.
+
+For the original codebase and documentation, refer to:  
+🔗 https://github.com/HLTCHKUST/cantonese-asr