Update README.md

README.md

@@ -1,3 +1,70 @@
 ---
 license: cc-by-nc-4.0
+language:
+- yue
+pretty_name: SBS Cantonese Speech Corpus
+size_categories:
+- 100K<n<1M
 ---
+# SBS Cantonese Speech Corpus
+
+This speech corpus contains 435 hours of [SBS Cantonese](https://www.sbs.com.au/language/chinese/zh-hant/podcast/sbs-cantonese) podcasts from Auguest 2022 to October 2023.
+There are 2,519 episodes and each episode is split into segments that are at most 10 seconds long. In total, there are 189,216 segments in this corpus.
+Here is a breakdown on the categories of episodes present in this dataset:
+
+<style>
+table th:first-of-type {
+    width: 5%;
+}
+table th:nth-of-type(2) {
+    width: 10%;
+}
+table th:nth-of-type(3) {
+    width: 50%;
+}
+</style>
+
+| Category          | SBS Channels         | Episodes |
+|-------------------|----------------------|-------|
+| news              | 中文新聞, 新聞簡報    | 622   |
+| business          | 寰宇金融            | 148   |
+| vaccine           | 疫苗快報            | 71    |
+| gardening         | 園藝趣談            | 58    |
+| tech              | 科技世界            | 56    |
+| health            | 健康快樂人          | 53    |
+| culture           | 文化360            | 49    |
+| english           | 學英語              | 41    |
+| expert            | 專家話你知          | 37    |
+| interview         | 我不是名人          | 20    |
+| career            | 澳洲招職            | 18    |
+| food              | 美食速遞            | 18    |
+| uncategorized     | n/a                | 1328  |
+
+
+* Uncategorized episodes are mostly news but also contains other categories listed above.
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+- **Curated by:** Kevin Li
+- **Language(s):** Cantonese, English (only in podcasts categorized as "english") 
+- **License:** Creative Commons Attribution Non-Commercial 4.0
+
+### Scraper
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Repository:** https://github.com/AlienKevin/sbs_cantonese
+
+## Uses
+
+Each episode is split into segments using [silero-vad](https://github.com/snakers4/silero-vad).
+Since silero-vad is not trained on Cantonese data, the segmentation is not ideal and often break sentences in the middle.
+Hence, this dataset is not intended to be used for supervised ASR. Instead, it is intended to be used for self-supervised
+speech pretraining, like training WavLM, HuBERT, and Wav2Vec.
+
+Each segment is stored as a monochannel FLAC file with a sample rate of 16k Hz. You can find the segments under the `audio/` folder,
+where groups of segments are bundled into a .tar.gz file for ease of distribution.