Add exp/default.yaml to configure experiments

README.md

@@ -17,22 +17,22 @@
 # Training
 ## Steps
 1. Change Wandb and data root variables in `shell_vars.sh` and `source shell_vars.sh`
-2. `python scripts/train.py model=demucs "effects_to_remove=[distortion]"`
+2. `python scripts/train.py +exp=default`
 
-## Main CLI Options
+## Experiments
+Training parameters can be configured in `cfg/exp/default.yaml`. Here are some descriptions
 - `max_kept_effects={n}` max number of <b> Kept </b> effects to apply to each file. Set to -1 to always use all effects (default: -1)
 - `max_removed_effects={n}` max number of <b> Removed </b> effects to apply to each file. Set to -1 to always use all effects (default: -1)
 - `model={model}` architecture to use (see 'Models')
-- `shuffle_kept_effects=True/False` Shuffle kept effects (default: True)
-- `shuffle_removed_effects=True/False` Shuffle removed effects (default: False)
 - `effects_to_use={effect}` Effects to use (see 'Effects') (default: all in the list)
 - `effects_to_remove={effect}` Effects to remove (see 'Effects') (default: all in the list)
-- `accelerator=null/gpu` Use GPU (1 device) (default: False)
+- `accelerator=null/'gpu'` Use GPU (1 device) (default: null)
 - `render_files=True/False` Render files. Disable to skip rendering stage (default: True)
 - `render_root={path/to/dir}`. Root directory to render files to (default: DATASET_ROOT)
 
 Note that "kept effects" are calculated from the difference between `effects_to_use` and `effects_to_remove`.
 
+These can also be specified on the command line.
 Example: `python scripts/train.py model=demucs "effects_to_use=[distortion, reverb, chorus]" "effects_to_remove=[distortion]" max_kept_effects=2 max_removed_effects=4 shuffle_kept_effects=False shuffle_removed_effects=True accelerator='gpu' render_root=/scratch/VocalSet'`
 
 Printout:
@@ -42,8 +42,6 @@ Apply kept effects: ['chorus', 'reverb'] (Up to 2, chosen in order) -> Dry
 Apply remove effects: ['distortion'] (Up to 4, chosen randomly) -> Wet
 ```
 
-See `cfg/config.yaml` for more options that can be specified on the command line.
-
 ## Models
 - `umx`
 - `demucs`

cfg/config.yaml

@@ -3,7 +3,6 @@ defaults:
   - model: null
   - effects: all
 
-
 seed: 12345
 train: True
 sample_rate: 48000

cfg/exp/default.yaml

@@ -0,0 +1,28 @@
+# @package _global_
+defaults:
+  - override /model: demucs
+  - override /effects: all
+seed: 12345
+sample_rate: 48000
+chunk_size: 262144 # 5.5s
+logs_dir: "./logs"
+render_files: True
+render_root: "./data"
+accelerator: null
+max_kept_effects: -1
+max_removed_effects: -1
+shuffle_kept_effects: True
+shuffle_removed_effects: True
+effects_to_use:
+  - compressor
+  - distortion
+  - reverb
+  - chorus
+effects_to_remove:
+  - compressor
+  - distortion
+  - reverb
+  - chorus
+datamodule:
+  batch_size: 16
+  num_workers: 8