guapaQAQ commited on
Commit
a76e19f
·
1 Parent(s): dce1695

update readme

Browse files
Files changed (1) hide show
  1. README.md +14 -1
README.md CHANGED
@@ -122,6 +122,7 @@ Each Parquet row has:
122
  | `template_idx` | str | template index if available |
123
  | `item_idx` | str | item index if available |
124
  | `text` | str | reference transcription / prompt |
 
125
  | `audio_bytes` | bytes | raw WAV file bytes |
126
  | `audio_format` | str | `"wav"` |
127
  | `sampling_rate` | int | e.g., `16000` |
@@ -162,6 +163,13 @@ print("WER:", wer.compute(references=refs, predictions=hyps))
162
 
163
  * **Basic**: clean split with plain text transcripts.
164
  * **Advanced**: adds inline timing tokens such as `<sil="Xms"/>`, enabling alignment-aware training and evaluation.
 
 
 
 
 
 
 
165
  * License: **CC BY 4.0** for text, metadata, and audio.
166
  * ZIP download is optional; Parquet streaming is the default recommended method.
167
 
@@ -170,7 +178,12 @@ print("WER:", wer.compute(references=refs, predictions=hyps))
170
  ## 📚 Citation
171
 
172
  ```
173
- (TO BE UPDATED)
 
 
 
 
 
174
  ```
175
 
176
  ---
 
122
  | `template_idx` | str | template index if available |
123
  | `item_idx` | str | item index if available |
124
  | `text` | str | reference transcription / prompt |
125
+ | `alignment` | str | alignment metadata (plain text or compact JSON); see notes for locations and parsing |
126
  | `audio_bytes` | bytes | raw WAV file bytes |
127
  | `audio_format` | str | `"wav"` |
128
  | `sampling_rate` | int | e.g., `16000` |
 
163
 
164
  * **Basic**: clean split with plain text transcripts.
165
  * **Advanced**: adds inline timing tokens such as `<sil="Xms"/>`, enabling alignment-aware training and evaluation.
166
+ * **Alignment files**: optional per-audio alignment metadata is supported and stored in the `alignment` column. During preparation the tools look for alignment files in several candidate locations relative to the source dataset tree (see `tools/prepare_gametime_basic.py` and `tools/prepare_gametime_advanced.py` for exact behavior). Common locations checked include:
167
+
168
+ - `alignments/<dataset_id>/<stem>.txt|.Text|.text`
169
+ - `alignments/<dataset_id>/<stem>.jsonl|.json`
170
+ - `alignments/<dataset_id>/<split>/<stem>[(.txt|.jsonl|.json)]`
171
+
172
+ If a JSON/JSONL file is found and contains an object with an `alignments` key, the loader stores a compact JSON string of that value in the `alignment` field; otherwise the raw file text (or parsed JSON) is stored as a string. If no alignment file is present, the `alignment` field is an empty string.
173
  * License: **CC BY 4.0** for text, metadata, and audio.
174
  * ZIP download is optional; Parquet streaming is the default recommended method.
175
 
 
178
  ## 📚 Citation
179
 
180
  ```
181
+ @article{chang2025gametime,
182
+ title = {Game-Time: Evaluating Temporal Dynamics in Spoken Language Models},
183
+ author = {Kai-Wei Chang and En-Pei Hu and Chun-Yi Kuan and Wenze Ren and Wei-Chih Chen and Guan-Ting Lin and Yu Tsao and Shao-Hua Sun and Hung-yi Lee and James Glass},
184
+ year = {2025},
185
+ note = {Manuscript under preparation}
186
+ }
187
  ```
188
 
189
  ---