Update README.md

README.md

@@ -24,4 +24,84 @@ pip install huggingface_hub
 # Download dataset
 hf download turnmaster/TurnMaster --repo-type dataset --local-dir ./TurnMaster
 
-cd TurnMaster
+cd TurnMaster
+
+
+# Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+
+# Project structure
+
+```text
+TurnMaster/
+├── audio/
+├── metadata/
+├── processing/
+│   ├── process_dataset.py
+│   ├── extract_shards.py
+│   ├── utils.py
+│   └── requirements.txt
+└── README.md
+```
+
+
+# Extract shards
+
+
+```bash
+# Extract to custom directory
+python extract_shards.py --sharded-dir ./TurnMaster --output-dir ./my_dataset
+```
+
+
+```bash
+# Extract from cached download
+python extract_shards.py --sharded-dir ~/.cache/huggingface/hub/datasets--turnmaster--TurnMaster/snapshots/main --output-dir my_dataset
+```
+
+### OPTIONAL: create a curated version of the dataset. You can also skip this step and reuse the standart curated version of TurnMaster
+
+```bash
+# Extract from cached download
+python extract_shards.py --sharded-dir ~/.cache/huggingface/hub/datasets--turnmaster--TurnMaster/snapshots/main --output-dir extracted
+```
+
+The dataset is now ready to be build with the custom augmentations.
+# Build dataset
+
+### Base (no silence)
+```bash
+python dataset_creation/augment_taskmaster.py \
+ --aug-dataset-save-dir YOUR/SAVE/DIR \
+ --taskmaster-root-dir DIR/TO/EXTRACTED/DATASET \
+ --silence-max-start 0.0 \
+ --silence-min-end 0.2 \
+ --silence-max-end 2.0 \
+ --normalize-text \
+ --custom-dollar-normalisation \
+ --keep-punct \
+ --lam 0.0 \
+ ```
+
+### Base silence insertion
+```bash
+python dataset_creation/augment_taskmaster.py \
+ --aug-dataset-save-dir YOUR/SAVE/DIR \
+ --taskmaster-root-dir DIR/TO/EXTRACTED/DATASET \
+ --silence-max-start 0.0 \
+ --silence-min-end 0.2 \
+ --silence-max-end 2.0 \
+ --normalize-text \
+ --custom-dollar-normalisation \
+ --keep-punct \
+ --silence-insertion \
+ --lam 0.0 \
+ --max-initial-silence-duration 1.5 \
+ --silence-insertion-max-s 2.0 \
+ --pause-per-second-ratio 1000.0
+ ```
+