README: document paired wav/txt WebDataset layout

README.md

@@ -53,21 +53,34 @@ ambiguity and dramatically improves prosody.
 
 ```
 metadata.csv          # 22,200 lines, pipe-delimited: filename|text_with_stress
-wavs_part_001.tar     # WAV files 000000…007399 (≈2.1 GB)
-wavs_part_002.tar     # WAV files 007400…014799 (≈3.2 GB)
-wavs_part_003.tar     # WAV files 014800…022199 (≈4.2 GB)
+wavs_part_001.tar     # WAV  files 000000…007399 (≈2.1 GB)
+wavs_part_002.tar     # WAV  files 007400…014799 (≈3.2 GB)
+wavs_part_003.tar     # WAV  files 014800…022199 (≈4.2 GB)
+texts_part_001.tar    # TXT  files 000000…007399 (≈7 MB)
+texts_part_002.tar    # TXT  files 007400…014799 (≈7 MB)
+texts_part_003.tar    # TXT  files 014800…022199 (≈7 MB)
 ```
 
+The data is laid out in the **WebDataset** convention: each sample consists of
+a `.wav` and a `.txt` sharing the same key (`000123_RUSLAN.wav` ↔
+`000123_RUSLAN.txt`). The HuggingFace dataset viewer pairs them automatically.
+
+`metadata.csv` is provided as a convenience for users who only want the text;
+it is the exact concatenation of all `.txt` files (`filename|text` per line).
+
 The audio is split into three uncompressed `.tar` shards instead of being
 uploaded as 22,200 individual files (HuggingFace rate-limits per-file commits
-on free tier). After download, extract each shard to get a flat `wavs/` folder:
+on free tier). After download, extract every shard to get flat `wavs/` and
+`texts/` folders:
 
 ```bash
-mkdir -p wavs
-for f in wavs_part_*.tar; do tar -xf "$f" -C wavs; done
+mkdir -p wavs texts
+for f in wavs_part_*.tar;  do tar -xf "$f" -C wavs;  done
+for f in texts_part_*.tar; do tar -xf "$f" -C texts; done
 ```
 
-Total: 22,200 mono 22 kHz WAV files (≈31 hours of speech).
+Total: 22,200 mono 22 kHz WAV files (≈31 hours of speech) + matching `.txt`
+transcripts with stress marks.
 
 ### Stress format
 
@@ -156,18 +169,30 @@ metadata.csv          # 22 200 строк, формат filename|текст_с_
 wavs_part_001.tar     # WAV-файлы 000000…007399 (≈2,1 ГБ)
 wavs_part_002.tar     # WAV-файлы 007400…014799 (≈3,2 ГБ)
 wavs_part_003.tar     # WAV-файлы 014800…022199 (≈4,2 ГБ)
+texts_part_001.tar    # TXT-файлы 000000…007399 (≈7 МБ)
+texts_part_002.tar    # TXT-файлы 007400…014799 (≈7 МБ)
+texts_part_003.tar    # TXT-файлы 014800…022199 (≈7 МБ)
 ```
 
+Данные оформлены по соглашению **WebDataset**: один сэмпл состоит из `.wav` и
+`.txt` с одинаковым ключом (`000123_RUSLAN.wav` ↔ `000123_RUSLAN.txt`). HF
+dataset viewer склеивает их автоматически и показывает текст рядом с аудио.
+
+`metadata.csv` приложен как удобство для тех, кому нужен только текст; он
+содержит ровно те же строки, что и `.txt` файлы (`filename|текст` в строку).
+
 Аудио сложено в три tar-шарда (без сжатия) вместо 22 200 отдельных файлов —
 бесплатный тариф HuggingFace ограничивает коммиты пофайлово. После скачивания
-распакуйте все шарды в одну папку `wavs/`:
+распакуйте все шарды:
 
 ```bash
-mkdir -p wavs
-for f in wavs_part_*.tar; do tar -xf "$f" -C wavs; done
+mkdir -p wavs texts
+for f in wavs_part_*.tar;  do tar -xf "$f" -C wavs;  done
+for f in texts_part_*.tar; do tar -xf "$f" -C texts; done
 ```
 
-Итого: 22 200 моно WAV-файлов 22 кГц (≈31 час речи).
+Итого: 22 200 моно WAV-файлов 22 кГц (≈31 час речи) + соответствующие `.txt`
+транскрипции с ударениями.
 
 ### Формат ударений