Update README.md

Added cleansing steps

README.md

@@ -1,24 +1,5 @@
 ---
 dataset_info:
-- config_name: clean
-  features:
-  - name: audio
-    dtype:
-      audio:
-        sampling_rate: 16000
-  - name: text
-    dtype: string
-  - name: id
-    dtype: string
-  - name: session_id
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 3354307483.0
-    num_examples: 46583
-  download_size: 3346711427
-  dataset_size: 3354307483.0
-- config_name: default
   features:
   - name: audio
     dtype:
@@ -37,10 +18,6 @@ dataset_info:
   download_size: 3346820592
   dataset_size: 3341105554.6299996
 configs:
-- config_name: clean
-  data_files:
-  - split: train
-    path: clean/train-*
 - config_name: default
   data_files:
   - split: train
@@ -53,10 +30,33 @@ configs:
 
 This dataset is derived from espnet/yodas, more details can be found here: https://huggingface.co/datasets/espnet/yodas
 
-This is a subset of the zh000 subset of espnet/yodas dataset, which focuses on videos with Mandarin-English code-switching phenomenon.
+This is a subset of the zh000 subset of espnet/yodas dataset, which selects videos with Mandarin-English code-switching phenomenon.
+
+Note that code-switching is only gauranteed per video rather than per utterance. Therefore, not every utterance in the dataset contains code-switching.
 
 ## Dataset Details
 
+### Dataset Usage
+The `default` config does not modify any text of the selected samples.
+```python
+from datasets import load_dataset
+cs_yodas = load_dataset("georgechang8/code_switch_yodas_zh")
+```
+The `clean` config cleanses the text of the selected samples (as in the processing).
+```python
+from datasets import load_dataset
+cs_yodas_clean = load_dataset("georgechang8/code_switch_yodas_zh", "clean")
+```
+```python
+{'audio': {'path': 'GaUSbuZm5Ec-00207-00083809-00084143.wav',
+  'array': array([-0.09082031,  0.01898193,  0.02850342, ...,  0.01419067,
+          0.01391602,  0.01513672]),
+  'sampling_rate': 16000},
+ 'text': '項明生，訂Agoda的項明生',
+ 'id': 'GaUSbuZm5Ec-00207-00083809-00084143',
+ 'session_id': 'GaUSbuZm5Ec'}
+```
+
 ### Dataset Description
 
 <!-- Provide a longer summary of what this dataset is. -->
@@ -226,6 +226,100 @@ audio_dataset.push_to_hub(
     embed_external_files=True
 )
 ```
+#### Data Cleaning
+1. The video `Pew9CK74axu` is manually cleaned
+```python
+def filter_fn(batch):
+    return (z == 'Pew9CK74axu' for z in batch['session_id'])
+
+special_care = audio_dataset.filter(filter_fn, num_proc=8, batched=True)
+with open("manual_edit.txt", "w", encoding="utf8") as f:
+    for l in special_care['text']:
+        f.write(l + "\n")
+# manual cleaning ...
+with open("manual_edit_finish.txt", "r", encoding="utf8") as f:
+    lines = list(map(str.strip, f.readlines()))
+replace_dict = {
+    a: b 
+    for a, b in zip(special_care['id'], lines)
+}
+def manual_edit(batch):
+    texts = []
+    for sid, orig in zip(batch['id'], batch['text']):
+        texts += [replace_dict.get(sid, orig)]
+    return {'text': texts}
+
+audio_dataset_manual = audio_dataset.map(manual_edit, batched=True, num_proc=8)
+```
+2. General cleansing pipeline
+```python
+import re
+import html
+
+def remove_emojies(text):
+  # Ref: https://gist.github.com/Alex-Just/e86110836f3f93fe7932290526529cd1#gistcomment-3208085
+  # Ref: https://en.wikipedia.org/wiki/Unicode_block
+  EMOJI_PATTERN = re.compile(
+    "["
+    "\U0001F1E0-\U0001F1FF"  # flags (iOS)
+    "\U0001F300-\U0001F5FF"  # symbols & pictographs
+    "\U0001F600-\U0001F64F"  # emoticons
+    "\U0001F680-\U0001F6FF"  # transport & map symbols
+    "\U0001F700-\U0001F77F"  # alchemical symbols
+    "\U0001F780-\U0001F7FF"  # Geometric Shapes Extended
+    "\U0001F800-\U0001F8FF"  # Supplemental Arrows-C
+    "\U0001F900-\U0001F9FF"  # Supplemental Symbols and Pictographs
+    "\U0001FA00-\U0001FA6F"  # Chess Symbols
+    "\U0001FA70-\U0001FAFF"  # Symbols and Pictographs Extended-A
+    "\U00002702-\U000027B0"  # Dingbats
+    "]"
+  )
+  text = re.sub(EMOJI_PATTERN, r' ', text)
+  return text
+
+def clean_transcripts(x):
+    cjk = "[\u3400-\u4db5\u4e00-\u9fa5\u9fa6-\u9fbb\uf900-\ufa2d\ufa30-\ufa6a\ufa70-\ufad9\uff00-\uffef\u2e80-\u2eff\u3000-\u303f\u31c0-\u31ef\u2f00-\u2fdf\u2ff0-\u2fff\u3100-\u312f\u31a0-\u31bf\ufe10-\ufe1f\ufe30-\ufe4f\u2600-\u26ff\u2700-\u27bf\u3200-\u32ff\u3300-\u33ff]"
+    x = html.unescape(x)
+    x = remove_emojies(x)
+    dots = '\.{3,}'
+    x = re.sub(rf'{dots}|…|\s|^|$', '  ', x)   # expanding space allows matching " uh uh" case
+    x = re.sub(rf"({cjk}|\s)([Uu][mh]|U[MH])({cjk}|\s)", r"\1 \3", x) # uh/um surrounded by cjk or space
+    x = re.sub(r"([HhEe]mm+|[HE]MM+)", " ", x) # hmm emm
+    x = re.sub(fr"\*+({cjk}+|[A-Za-z]+)\*+", " ", x)  # *叹气* 
+    x = re.sub(r'[呃嗯]', ' ', x)  # 呃嗯
+    def replace_except(pattern, repl, z, excs):
+        for e, t in excs:
+            z = z.replace(e, t)
+        z = re.sub(pattern, repl, z)
+        for e, t in excs:
+            z = z.replace(t, e)
+        return z
+    # remove 恩 except for 恩桥 感恩 恩怨
+    x = replace_except("恩", ' ', x, excs=[("感恩", "呃"),("恩桥", "嗯"),("恩怨", "emm")])
+    # remove (...) except for 'Program Files (x86)'
+    x = re.sub(r'（[^（）]*）', ' ', x)
+    x = re.sub(r"\s+", " ", x)
+    x = replace_except(r'\([^()]*\)', ' ', x, excs=[("Program Files (x86)", "呃")])
+    puncs = r'[，？！。；?!,;~～]'
+    x = re.sub(rf'({puncs})(?:\s*\1)+', r'\1', x) # ？？？ -> ？
+    x = re.sub(rf"\s+({puncs})", r'\1', x) # text , -> text,
+    sp_puncs = r'[?!,;]' # puncs with spaces
+    x = re.sub(rf"({puncs}*{sp_puncs})([a-zA-Z])", r'\1 \2', x) # text,cont -> text, cont
+    x = re.sub(rf"^[\s]*{puncs}+", "", x) # leading puncs
+    x = re.sub(r"\s+", " ", x) # excess spaces
+    return x.strip()
+
+audio_dataset_manual_clean = audio_dataset_manual.map(lambda x: {"text": list(map(clean_transcripts, x['text']))}, batched=True, num_proc=8)
+# push to hub
+audio_dataset_manual_clean.push_to_hub(
+    "georgechang8/code_switch_yodas_zh",
+    config_name="clean",
+    set_default=False,
+    commit_message="Clean transcript",
+    max_shard_size="1GB",
+    embed_external_files=True,
+)
+```
 
 ## Limitations