Move FAQs higher up on Readme (#5)

- Move FAQs higher up on Readme (4a7fce891e208be344b67a74ce99420498a8f5dd)


Co-authored-by: Jason Li <[email protected]>

README.md

@@ -35,6 +35,20 @@ The metadata contains estimated bandwidth, which can be used to infer the origin
 
 LibriVox audiobooks are not redistributed on Hugging Face. All audio in the dataset can be downloaded from LibriVox, following the instructions below.
 
+### Frequently Asked Questions
+- 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.
+- 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.`
+- 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.
+- If you want to retry the download for failed audiobooks, rerun the script with the output *errors_22khz.json* file:
+    ```bash
+    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/errors_22khz.json" \
+        max_workers=8
+    ```
+
 ## Dataset Format
 
 The dataset contains an utterance level manifest with these fields:
@@ -83,22 +97,7 @@ python /home/NeMo-speech-data-processor/main.py \
 
 *max_workers* is the number of threads to use for downloading the data. To download the 44khz dataset, specify *config_44khz.yaml*.
 
-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.
-
-During download there might be warning messages from "libmpg123". These warnings can be safely ignored.
-
-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.
-
-If you want to retry the download for failed audiobooks, rerun the script with the output *errors_22khz.json* file. 
-
-```bash
-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/errors_22khz.json" \
-    max_workers=8
-```
+Please see [FAQs](#frequently-asked-questions) for further help regarding download. Or raise an issue on the community tab.
 
 ## Dataset Owner(s)