guapaQAQ commited on
Commit
fe61e14
Β·
1 Parent(s): b901178

update readme

Browse files
Files changed (1) hide show
  1. README.md +35 -11
README.md CHANGED
@@ -71,20 +71,44 @@ print(ex_adv["id"], sr_adv, len(wav_adv), ex_adv["text"])
71
 
72
  ### 2️⃣ Optional β€” Full ZIP Download
73
 
74
- If you prefer the original folder layout:
 
 
75
 
76
  ```
77
- gametime/basic/
78
- β”œβ”€β”€ ...*-dataset.json
 
79
  β”œβ”€β”€ audios/
80
- β”‚ β”œβ”€β”€ .../*.wav
 
 
 
 
 
 
 
 
81
 
82
- gametime/advanced/
83
- β”œβ”€β”€ ...*-dataset.json
 
 
84
  β”œβ”€β”€ audios/
85
- β”‚ β”œβ”€β”€ test/*.wav
 
 
 
 
 
86
  ```
87
 
 
 
 
 
 
 
88
  ```python
89
  from huggingface_hub import hf_hub_download
90
  import os
@@ -93,7 +117,7 @@ token = os.getenv("HF_TOKEN") or "<YOUR_HF_TOKEN>"
93
  path = hf_hub_download(
94
  repo_id="gametime-benchmark/gametime",
95
  repo_type="dataset",
96
- filename="download/gametime_advanced_v1.zip",
97
  revision="main",
98
  token=token,
99
  local_dir=".",
@@ -101,12 +125,12 @@ path = hf_hub_download(
101
  print("saved to:", path)
102
  ```
103
 
 
 
104
  ```bash
105
- unzip download/gametime_advanced_v1.zip
106
  ```
107
 
108
- This preserves the `gametime/advanced` directory tree exactly as in source.
109
-
110
  ---
111
 
112
  ## πŸ“‘ Schema
 
71
 
72
  ### 2️⃣ Optional β€” Full ZIP Download
73
 
74
+ If you prefer the original folder layout you can download one of the ZIPs packaged in `gametime/download/`. There are two kinds available in this repository:
75
+
76
+ - `gametime/download/basic_instructions.zip` β€” unpacks to:
77
 
78
  ```
79
+ basic_instructions/
80
+ β”œβ”€β”€ text/
81
+ β”‚ β”œβ”€β”€ *-dataset.json # per-dataset JSON manifest(s)
82
  β”œβ”€β”€ audios/
83
+ β”‚ β”œβ”€β”€ <dataset_id>/
84
+ β”‚ β”‚ β”œβ”€β”€ train/*.wav
85
+ β”‚ β”‚ └── test/*.wav
86
+ β”œβ”€β”€ alignments/ # per-audio alignment files
87
+ β”‚ β”œβ”€β”€ <dataset_id>/
88
+ β”‚ β”‚ β”œβ”€β”€ <stem>.jsonl
89
+ ```
90
+
91
+ - `gametime/download/advanced_instructions.zip` β€” unpacks to:
92
 
93
+ ```
94
+ advanced_instructions/
95
+ β”œβ”€β”€ text/
96
+ β”‚ β”œβ”€β”€ *-dataset.json # per-dataset JSON manifest(s) with timing tokens
97
  β”œβ”€β”€ audios/
98
+ β”‚ β”œβ”€β”€ <dataset_id>/
99
+ β”‚ β”‚ β”œβ”€β”€ train/*.wav
100
+ β”‚ β”‚ └── test/*.wav
101
+ β”œβ”€β”€ alignments/ # per-audio alignment files
102
+ β”‚ β”œβ”€β”€ <dataset_id>/
103
+ β”‚ β”‚ β”œβ”€β”€ <stem>.jsonl
104
  ```
105
 
106
+ Notes:
107
+
108
+ - Each ZIP in `gametime/download/` preserves the original source tree names (`basic_instructions/` or `advanced_instructions/`).
109
+
110
+ Download example (Hugging Face):
111
+
112
  ```python
113
  from huggingface_hub import hf_hub_download
114
  import os
 
117
  path = hf_hub_download(
118
  repo_id="gametime-benchmark/gametime",
119
  repo_type="dataset",
120
+ filename="download/basic_instructions.zip",
121
  revision="main",
122
  token=token,
123
  local_dir=".",
 
125
  print("saved to:", path)
126
  ```
127
 
128
+ Unzip example:
129
+
130
  ```bash
131
+ unzip gametime/download/basic_instructions.zip
132
  ```
133
 
 
 
134
  ---
135
 
136
  ## πŸ“‘ Schema