Add effect configurations

README.md

@@ -6,36 +6,30 @@
 4. `git submodule update --init --recursive`
 5. `pip install -e umx`
 
-## Download [GuitarFX Dataset](https://zenodo.org/record/7044411/)
-`./scripts/download_egfx.sh`
+## Download [VocalSet Dataset](https://zenodo.org/record/1193957)
+1. `wget https://zenodo.org/record/1193957/files/VocalSet.zip?download=1`
+2. `mv VocalSet.zip?download=1 VocalSet.zip`
+3. `unzip VocalSet.zip`
+4. Manually split singers into train, val, test directories
 
 ## Train model
 1. Change Wandb variables in `shell_vars.sh` and `source shell_vars.sh`
-2. `python scripts/train.py exp=audio_diffusion`
+2. `python scripts/train.py +exp=umx_distortion`
 or
-2. `python scripts/train.py exp=umx`
-or
-2. `python scripts/train.py exp=demucs`
-
+2. `python scripts/train.py +exp=demucs_distortion`
+See cfg for more options. Generally they are `+exp={model}_{effect}`
+Models and effects detailed below.
 
 To add gpu, add `trainer.accelerator='gpu' trainer.devices=-1` to the command-line
 
-Ex. `python train.py exp=umx trainer.accelerator='gpu' trainer.devices=-1`
+Ex. `python scripts/train.py +exp=umx_distortion trainer.accelerator='gpu' trainer.devices=-1`
 
-### Effects
-Default effect is RAT (distortion). Effect choices:
-- BluesDriver
-- Clean
-- Flanger
-- Phaser
-- RAT
-- Sweep Echo
-- TubeScreamer
-- Chorus
-- Digital Delay
-- Hall Reverb
-- Plate Reverb
-- Spring Reverb
-- TapeEcho
+### Current Models
+- `umx`
+- `demucs`
 
-Change effect by adding `+datamodule.dataset.effect_types=["{Effect}"]` to the command-line
+### Current Effects
+- `chorus`
+- `compressor`
+- `distortion`
+- `reverb`

cfg/effects/chorus.yaml

@@ -0,0 +1,20 @@
+# @package _global_
+effects:
+  train_effects:
+      Chorus:
+        _target_: remfx.effects.RandomPedalboardChorus
+        sample_rate: ${sample_rate}
+  val_effects:
+      Chorus:
+        _target_: remfx.effects.RandomPedalboardChorus
+        sample_rate: ${sample_rate}
+        min_rate_hz: 1.0
+        max_rate_hz: 1.0
+        min_depth: 0.3
+        max_depth: 0.3
+        min_centre_delay_ms: 7.5
+        max_centre_delay_ms: 7.5
+        min_feedback: 0.4
+        max_feedback: 0.4
+        min_mix: 0.4
+        max_mix: 0.4

cfg/effects/compressor.yaml

@@ -0,0 +1,22 @@
+# @package _global_
+effects:
+  train_effects:
+      Compressor:
+        _target_: remfx.effects.RandomPedalboardCompressor
+        sample_rate: ${sample_rate}
+        min_threshold_db: -42.0
+        max_threshold_db: -20.0
+        min_ratio: 1.5
+        max_ratio: 6.0
+  val_effects:
+      Compressor:
+        _target_: remfx.effects.RandomPedalboardCompressor
+        sample_rate: ${sample_rate}
+        min_threshold_db: -32
+        max_threshold_db: -32
+        min_ratio: 3.0
+        max_ratio: 3.0
+        min_attack_ms: 10.0
+        max_attack_ms: 10.0
+        min_release_ms: 40.0
+        max_release_ms: 40.0

cfg/effects/reverb.yaml

@@ -0,0 +1,26 @@
+# @package _global_
+effects:
+  train_effects:
+      Reverb:
+        _target_: remfx.effects.RandomPedalboardReverb
+        sample_rate: ${sample_rate}
+        min_room_size: 0.3
+        max_room_size: 1.0
+        min_damping: 0.2
+        max_damping: 1.0
+        min_wet_dry: 0.2
+        max_wet_dry: 0.8
+        min_width: 0.2
+        max_width: 1.0
+  val_effects:
+      Reverb:
+        _target_: remfx.effects.RandomPedalboardReverb
+        sample_rate: ${sample_rate}
+        min_room_size: 0.5
+        max_room_size: 0.5
+        min_damping: 0.5
+        max_damping: 0.5
+        min_wet_dry: 0.4
+        max_wet_dry: 0.4
+        min_width: 0.5
+        max_width: 0.5

cfg/exp/demucs_chorus.yaml

@@ -0,0 +1,4 @@
+# @package _global_
+defaults:
+  - override /model: demucs
+  - override /effects: chorus

cfg/exp/demucs_compression.yaml

@@ -0,0 +1,4 @@
+# @package _global_
+defaults:
+  - override /model: demucs
+  - override /effects: compression

cfg/exp/demucs_reverb.yaml

@@ -0,0 +1,4 @@
+# @package _global_
+defaults:
+  - override /model: demucs
+  - override /effects: reverb

cfg/exp/umx_chorus.yaml

@@ -0,0 +1,4 @@
+# @package _global_
+defaults:
+  - override /model: umx
+  - override /effects: chorus

cfg/exp/umx_compression.yaml

@@ -0,0 +1,4 @@
+# @package _global_
+defaults:
+  - override /model: umx
+  - override /effects: compression

cfg/exp/umx_reverb.yaml

@@ -0,0 +1,4 @@
+# @package _global_
+defaults:
+  - override /model: umx
+  - override /effects: reverb

remfx/effects.py

@@ -574,7 +574,7 @@ class RandomSoxReverb(torch.nn.Module):
         return (x * (1 - wet_dry)) + (y * wet_dry)
 
 
-class RandomPebalboardReverb(torch.nn.Module):
+class RandomPedalboardReverb(torch.nn.Module):
     def __init__(
         self,
         sample_rate: float,

scripts/train.py

@@ -12,7 +12,6 @@ def main(cfg: DictConfig):
     # Apply seed for reproducibility
     if cfg.seed:
         pl.seed_everything(cfg.seed)
-    print(cfg)
     log.info(f"Instantiating datamodule <{cfg.datamodule._target_}>.")
     datamodule = hydra.utils.instantiate(cfg.datamodule, _convert_="partial")
     log.info(f"Instantiating model <{cfg.model._target_}>.")