mattricesound commited on
Commit
384b78d
1 Parent(s): f91cab1

Refactor README

Browse files
Files changed (1) hide show
  1. README.md +15 -13
README.md CHANGED
@@ -1,4 +1,6 @@
1
 
 
 
2
  ## Install Packages
3
  1. `python3 -m venv env`
4
  2. `source env/bin/activate`
@@ -12,22 +14,12 @@
12
  3. `unzip VocalSet.zip`
13
  4. Manually split singers into train, val, test directories
14
 
15
- ## Train model
 
16
  1. Change Wandb and data root variables in `shell_vars.sh` and `source shell_vars.sh`
17
  2. `python scripts/train.py model=demucs "effects_to_remove=[distortion]"`
18
 
19
-
20
- ## Models
21
- - `umx`
22
- - `demucs`
23
-
24
- ## Effects
25
- - `chorus`
26
- - `compressor`
27
- - `distortion`
28
- - `reverb`
29
-
30
- ## Train Main CLI Options
31
  - `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)
32
  - `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)
33
  - `model={model}` architecture to use (see 'Models')
@@ -52,5 +44,15 @@ Apply remove effects: ['distortion'] (Up to 4, chosen randomly) -> Wet
52
 
53
  See `cfg/config.yaml` for more options that can be specified on the command line.
54
 
 
 
 
 
 
 
 
 
 
 
55
  ## Misc.
56
  By default, files are rendered to `input_dir / processed / {string_of_effects} / {train|val|test}`.
 
1
 
2
+ # Setup
3
+
4
  ## Install Packages
5
  1. `python3 -m venv env`
6
  2. `source env/bin/activate`
 
14
  3. `unzip VocalSet.zip`
15
  4. Manually split singers into train, val, test directories
16
 
17
+ # Training
18
+ ## Steps
19
  1. Change Wandb and data root variables in `shell_vars.sh` and `source shell_vars.sh`
20
  2. `python scripts/train.py model=demucs "effects_to_remove=[distortion]"`
21
 
22
+ ## Main CLI Options
 
 
 
 
 
 
 
 
 
 
 
23
  - `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)
24
  - `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)
25
  - `model={model}` architecture to use (see 'Models')
 
44
 
45
  See `cfg/config.yaml` for more options that can be specified on the command line.
46
 
47
+ ## Models
48
+ - `umx`
49
+ - `demucs`
50
+
51
+ ## Effects
52
+ - `chorus`
53
+ - `compressor`
54
+ - `distortion`
55
+ - `reverb`
56
+
57
  ## Misc.
58
  By default, files are rendered to `input_dir / processed / {string_of_effects} / {train|val|test}`.