Update README.md

README.md

@@ -7,6 +7,12 @@ configs:
     path: "22khz/manifest_22khz.json"
   - split: chapters
     path: "22khz/chapters_22khz.json"
+- config_name: 44khz
+  data_files:
+  - split: manifest
+    path: "44khz/manifest_44khz.json"
+  - split: chapters
+    path: "44khz/chapters_44khz.json"
 ---
 
 # HiFiTTS-2: A Large-Scale High Bandwidth Speech Dataset
@@ -23,11 +29,36 @@ padding: 0;
 
 This repository contains the metadata for HiFiTTS-2, a large scale speech dataset derived from LibriVox audiobooks. For more details, please refer to our paper. [TODO: Add ArXiv link]
 
-The dataset contains metadata for approximately 36.7k hours of audio that can be downloaded from LibriVox at a 48 kHz sampling rate.
+The dataset contains metadata for approximately 36.7k hours of audio from 5k speakers that can be downloaded from LibriVox at a 48 kHz sampling rate.
+
+The metadata contains estimated bandwidth, which can be used to infer the original sampling rate the audio was recorded at. The base dataset is filtered for a bandwidth appropriate for training speech models at 22 kHz. We also provide a precomputed subset with 31.7k hours appropraite for 44 kHz training. Users can modify the download script to use any sampling rate and bandwidth threshold which might be more appropriate for their work.
+
+Due to ethical considerations, we do not redistribute LibriVox audiobooks on Hugging Face. All audio in the dataset can be downloaded from LibriVox, following the instructions below.
+
+## Dataset Format
+
+The dataset contains an utterance level manifest with these fields:
+
+- **audio_filepath**: Relative path where utterance is stored
+- **speaker**: LibriVox speaker ID
+- **set**: Dataset partition, either "train", "test_seen", "dev_seen", "test_unseen", or "dev_unseen"
+- **duration**: Duration of utterance
+- **bandwidth**: Estimated bandwidth of audiobook chapter containing this utterance.
+- **wer**: ASR word error rate of *normalized_text*
+- **cer**: ASR character error rate of *normalized_text*
+- **text_source**: Data source text was taken from, either 'book' or 'mls'
+- **text**: Original data source transcription
+- **normalized_text**: Transcription output by text processing pipeline
 
-The metadata contains estimated bandwidth, which can be used to infer the original sampling rate the audio was recorded at. The base dataset is filtered for a bandwidth appropriate for training speech models at *22 kHz*. We also provide a precomputed subset with 31.7k hours appropraite for *44 kHz* training. Users can modify the download script to use any sampling rate and bandwidth threshold which might be more appropriate for their work.
+The dataset contains an audiobook chapter level manifest with these fields:
 
-Due to legal and ethical considerations, we do not redistribute LibriVox audiobooks on Hugging Face. All audio in the dataset can be downloaded from LibriVox, following the instructions below.
+- **url**: Download URL for the LibriVox audiobook chapter
+- **chapter_filepath**: Relative path where audiobook chapter is stored
+- **bandwidth**: Bandwidth estimated using the first 30 seconds of the chapter
+- **utterances**: List of utterance metadata with the following fields
+- **utterances.audio_filepath**: Relative path where utterance is stored
+- **utterances.offset**: Offset of utterance within the chapter
+- **utterances.duration**: Duration of utterance
 
 ## Download Instructions
 
@@ -54,7 +85,7 @@ python /home/NeMo-speech-data-processor/main.py \
     --config-path="/home/NeMo-speech-data-processor/dataset_configs/english/hifitts2" \
     --config-name="config_22khz.yaml" \
     workspace_dir="/home/hifitts2" \
-    chapter_filename="/home/hifitts2/chapters_22khz.json" \
+    chapter_filename="/home/hifitts2/errors_22khz.json" \
     max_workers=8
 ```