Update README.md

README.md

@@ -1,25 +1,102 @@
----
-license: unknown
-configs:
-- config_name: 0verflow_Shiny_Days
-  data_files:
-  - split: train
-    path: 0verflow_Shiny_Days/train-*
-dataset_info:
-  config_name: 0verflow_Shiny_Days
-  features:
-  - name: audio
-    dtype:
-      audio:
-        sampling_rate: 48000
-  - name: text
-    dtype: string
-  - name: audio_ID
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 940144571.088
-    num_examples: 37616
-  download_size: 1073144264
-  dataset_size: 940144571.088
----
+---
+license: unknown
+configs:
+- config_name: 0verflow_Shiny_Days
+  data_files:
+  - split: train
+    path: 0verflow_Shiny_Days/train-*
+dataset_info:
+  config_name: 0verflow_Shiny_Days
+  features:
+  - name: audio
+    dtype:
+      audio:
+        sampling_rate: 48000
+  - name: text
+    dtype: string
+  - name: audio_ID
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 940144571.088
+    num_examples: 37616
+  download_size: 1073144264
+  dataset_size: 940144571.088
+task_categories:
+- automatic-speech-recognition
+- text-to-speech
+language:
+- ja
+tags:
+- speech
+- anime
+- japanese
+size_categories:
+- 100K<n<1M
+---
+
+# Galgame VisualNovel Reupload
+
+This repository is a reupload of the visual novel dataset [OOPPEENN/56697375616C4E6F76656C5F44617461736574](https://huggingface.co/datasets/OOPPEENN/56697375616C4E6F76656C5F44617461736574).
+
+The goal of this reupload is to restructure the data for easier and more efficient use with the `datasets` library, instead of having to manually extract each archive file and parse json files of the original dataset.
+
+### Loading the entire dataset
+
+To load and stream all voice lines from all games combined, simply load the `train` split. The library will automatically retrieve the data from all subsets.
+
+```python
+from datasets import load_dataset
+
+# This will stream all data from all games
+dataset = load_dataset("joujiboi/GalgameDataset-reupload", split="train", streaming=True)
+
+# Get the first example
+first_example = next(iter(dataset))
+print(first_example)
+# {'audio': {'path': '...', 'array': ..., 'sampling_rate': 48000}, 'text': '...', 'audio_ID': '...'}
+
+### Loading data from Single Game
+
+To load data from only one game, use the name parameter with the game's subset name.
+
+```python
+from datasets import load_dataset
+
+# Load only the data for 0verflow_Cross_Days subset
+cross_days_subset = load_dataset("joujiboi/GalgameDataset-reupload", name="0verflow_Cross_Days", split="train")
+
+print(f"Number of lines in Cross Days: {len(cross_days_subset)}")
+```
+
+You can get a list of all available games (subsets) like so:
+```python
+from datasets import get_dataset_config_names
+
+all_games = get_dataset_config_names("joujiboi/GalgameDataset-reupload")
+print(all_games)
+# ['0verflow_Cross_Days', '0verflow_School_Days_HQ', '0verflow_Shiny_Days', ...]
+```
+
+### Reupload information
+
+The audio files and transcribed text are identical to the original source. No data has been altered or removed.
+
+The CATALOG.md and TOTAL.md files in this repository are copies from the original dataset.
+
+The script used to perform this reupload is included in this repository as `reupload_dataset.py`.
+
+
+## Disclaimer, Copyright, and Legal Notice
+
+The audio and text data in this dataset are derived from commercially available visual novels. These original works are protected by copyright, and the rights belong to their respective publishers and creators. The uploader of this repository does not own the copyright to any of the underlying creative works and does not claim to.
+
+This repository's sole purpose is to restructure the publicly available data from the `OOPPEENN/56697375616C4E6F76656C5F44617461736574` dataset into a format that is more accessible for potential non-commercial research in fields such as natural language processing and speech synthesis.
+
+The original repository listed an MIT license. This is incorrect, as such a license can only be granted by the copyright holders. Therefore, this dataset should be considered to have **NO LICENSE**. All rights to the content remain with the original copyright holders.
+
+The uploader of this dataset assumes no responsibility or liability for any legal consequences, damages, or losses that may arise from the use, misuse, or distribution of this dataset.
+
+**Users of this dataset are solely responsible for ensuring that their use complies with the copyright laws of their specific jurisdiction.** By downloading or using this data, you acknowledge that you are doing so at your own risk.
+
+If you are a copyright holder and believe that your work has been included in this dataset improperly, please open an issue on this repository. Valid requests for content removal will be honored promptly.