Move FAQs higher up on Readme
#5
by
blisc
- opened
README.md
CHANGED
@@ -35,6 +35,20 @@ The metadata contains estimated bandwidth, which can be used to infer the origin
|
|
35 |
|
36 |
LibriVox audiobooks are not redistributed on Hugging Face. All audio in the dataset can be downloaded from LibriVox, following the instructions below.
|
37 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
38 |
## Dataset Format
|
39 |
|
40 |
The dataset contains an utterance level manifest with these fields:
|
@@ -83,22 +97,7 @@ python /home/NeMo-speech-data-processor/main.py \
|
|
83 |
|
84 |
*max_workers* is the number of threads to use for downloading the data. To download the 44khz dataset, specify *config_44khz.yaml*.
|
85 |
|
86 |
-
|
87 |
-
|
88 |
-
During download there might be warning messages from "libmpg123". These warnings can be safely ignored.
|
89 |
-
|
90 |
-
By default, the script will download audio files into the workspace directory under *{workspace_dir}/audio_22khz*. The download will ignore HTTP errors and store information for any failed downloads into *{workspace_dir}/errors_22khz.json*. A new manifest will be created at *{worksapce_dir}/manifest_filtered_22khz.json* with utterances from failed audiobooks removed. You can override the default behavior by modifying the [config.yaml file](https://github.com/NVIDIA/NeMo-speech-data-processor/blob/main/dataset_configs/english/hifitts2/config_22khz.yaml) in your local SDP repository.
|
91 |
-
|
92 |
-
If you want to retry the download for failed audiobooks, rerun the script with the output *errors_22khz.json* file.
|
93 |
-
|
94 |
-
```bash
|
95 |
-
python /home/NeMo-speech-data-processor/main.py \
|
96 |
-
--config-path="/home/NeMo-speech-data-processor/dataset_configs/english/hifitts2" \
|
97 |
-
--config-name="config_22khz.yaml" \
|
98 |
-
workspace_dir="/home/hifitts2" \
|
99 |
-
chapter_filename="/home/hifitts2/errors_22khz.json" \
|
100 |
-
max_workers=8
|
101 |
-
```
|
102 |
|
103 |
## Dataset Owner(s)
|
104 |
|
|
|
35 |
|
36 |
LibriVox audiobooks are not redistributed on Hugging Face. All audio in the dataset can be downloaded from LibriVox, following the instructions below.
|
37 |
|
38 |
+
### Frequently Asked Questions
|
39 |
+
- Downloading the 22 kHz version will require approximately 2.8TB of disk space. Downloading the 44 kHz version will require approximately 4.0TB of disk space.
|
40 |
+
- During download there might be warning messages from "libmpg123". These warnings can be safely ignored. These errors look like `[src/libmpg123/id3.c:INT123_id3_to_utf8():394] warning: Weird tag size 119 for encoding 1 - I will probably trim too early or something but I think the MP3 is broken.`
|
41 |
+
- By default, the script will download audio files into the workspace directory under *{workspace_dir}/audio_22khz*. The download will ignore HTTP errors and store information for any failed downloads into *{workspace_dir}/errors_22khz.json*. A new manifest will be created at *{worksapce_dir}/manifest_filtered_22khz.json* with utterances from failed audiobooks removed. You can override the default behavior by modifying the [config.yaml file](https://github.com/NVIDIA/NeMo-speech-data-processor/blob/main/dataset_configs/english/hifitts2/config_22khz.yaml) in your local SDP repository.
|
42 |
+
- If you want to retry the download for failed audiobooks, rerun the script with the output *errors_22khz.json* file:
|
43 |
+
```bash
|
44 |
+
python /home/NeMo-speech-data-processor/main.py \
|
45 |
+
--config-path="/home/NeMo-speech-data-processor/dataset_configs/english/hifitts2" \
|
46 |
+
--config-name="config_22khz.yaml" \
|
47 |
+
workspace_dir="/home/hifitts2" \
|
48 |
+
chapter_filename="/home/hifitts2/errors_22khz.json" \
|
49 |
+
max_workers=8
|
50 |
+
```
|
51 |
+
|
52 |
## Dataset Format
|
53 |
|
54 |
The dataset contains an utterance level manifest with these fields:
|
|
|
97 |
|
98 |
*max_workers* is the number of threads to use for downloading the data. To download the 44khz dataset, specify *config_44khz.yaml*.
|
99 |
|
100 |
+
Please see [FAQs](#frequently-asked-questions) for further help regarding download. Or raise an issue on the community tab.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
101 |
|
102 |
## Dataset Owner(s)
|
103 |
|