Upload README.md with huggingface_hub

README.md

@@ -1,41 +1,14 @@
 ---
+task_categories:
+- audio-classification
+- automatic-speech-recognition
+- text-to-speech
 language:
 - zh
 - en
 - ja
 - ko
-task_categories:
-- audio-classification
-- automatic-speech-recognition
-- text-to-speech
 pretty_name: Genshin Voice
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-dataset_info:
-  features:
-  - name: audio
-    dtype: audio
-  - name: transcription
-    dtype: string
-  - name: language
-    dtype: string
-  - name: speaker
-    dtype: string
-  - name: speaker_type
-    dtype: string
-  - name: type
-    dtype: string
-  - name: inGameFilename
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 247309786538.984
-    num_examples: 413429
-  download_size: 201995753083
-  dataset_size: 247309786538.984
 ---
 
 # Genshin Voice
@@ -45,13 +18,13 @@ Genshin Voice is a dataset of voice lines from the popular game [Genshin Impact]
 Hugging Face 🤗  [Genshin-Voice](https://huggingface.co/datasets/simon3000/genshin-voice)
 
 <!-- STATS -->
-Last update at `2024-04-29`
+Last update at `2024-04-30`
 
 `413429` wavs
 
-`30450` without speaker (7%)
+`18016` without speaker (4%)
 
-`37295` without transcription (9%)
+`22956` without transcription (6%)
 
 `720` without inGameFilename (0%)
 <!-- STATS_END -->
@@ -68,20 +41,63 @@ The voice lines are spoken by the characters in the game and cover a wide range
 
 ## Uses
 
-result.json format:
+To install Hugging Face's datasets library, follow the instructions from [this link](https://huggingface.co/docs/datasets/installation#audio).
+
+### Example: Load the dataset and filter for Chinese voices of Ganyu with transcriptions
+
+```python
+from datasets import load_dataset
+import soundfile as sf
+import os
+
+# Load the dataset
+dataset = load_dataset('simon3000/genshin-voice', split='train', streaming=True)
+
+# Filter the dataset for Chinese voices of Ganyu with transcriptions
+chinese_ganyu = dataset.filter(lambda voice: voice['language'] == 'Chinese' and voice['speaker'] == 'Ganyu' and voice['transcription'] != '')
+
+# Create a folder to store the audio and transcription files
+ganyu_folder = 'ganyu'
+os.makedirs(ganyu_folder, exist_ok=True)
+
+# Process each voice in the filtered dataset
+for i, voice in enumerate(chinese_ganyu):
+  audio_path = os.path.join(ganyu_folder, f'{i}_audio.wav')  # Path to save the audio file
+  transcription_path = os.path.join(ganyu_folder, f'{i}_transcription.txt')  # Path to save the transcription file
+  
+  # Save the audio file
+  sf.write(audio_path, voice['audio']['array'], voice['audio']['sampling_rate'])
+
+  # Save the transcription file
+  with open(transcription_path, 'w') as transcription_file:
+    transcription_file.write(voice['transcription'])
+
+  print(f'{i} done')  # Print the progress
+```
+
+### You unpacked the game and just want to know what the wavs are about
+
+result.json format: (subject to change)
 
 ```json
 {
-  "0586907bf153a66f.wav": {
-    "fileName": "VO_GCG_Monster\\VO_GCG_Skirmisher_Rifle_Fire\\vo_GCG_monster_Skirmisher_Rifle_Fire_Die_01.wem",
+  "9b5502fb1b83cb97.wav": {
+    "inGameFilename": "VO_friendship\\VO_raidenShogun\\vo_raidenEi_dialog_pendant.wem",
+    "filename": "9b5502fb1b83cb97.wav",
     "language": "English(US)",
-    "text": "This is... a 【complex】 dialog triggered by the 【editor】!",
-    "guid": "48382634-17c2-432f-9372-3ab11f6d84ce",
-    "talkRole": "Mei",
-    "talkRoleType": "TALK_ROLE_NPC",
-    "gameTrigger": "Card",
-    "gameTriggerArgs": 101
-  },
+    "transcription": "Really? So in all this time, no new Electro Visions have appeared in the outside world? Well, what I can say on this topic is subject to certain constraints, but... it is not by my will that Visions are granted or denied. The key is people's desire, and... well, there's another side to it too.",
+    "speaker": "Raiden Shogun",
+    "talkRoleType": "",
+    "talkRoleID": "",
+    "guid": "f8e72b65-6c0a-4df1-a2f0-2bb08dbeab75",
+    "voiceConfigs": [
+      {
+        "gameTrigger": "Fetter",
+        "gameTriggerArgs": 3001,
+        "avatarName": "Switch_raidenShogun"
+      }
+    ]
+  }
 }
 ```
 
@@ -107,6 +123,8 @@ The dataset contains official annotations from the game, including language, spe
 
 Annotations are incomplete. Some voice lines are missing speaker names and transcriptions.
 
+Speakers and transcriptions may contain markups and placeholders: `#<color=#37FFFF>パイモン：</color>{NICKNAME}、すごく怖い悪夢を見たことってあるか？\\n<color=#37FFFF>{NICKNAME}：...`
+
 ### Recommendations
 
 Users should be made aware of the risks, biases and limitations of the dataset.