README.md

## Install Packages
1. `python3 -m venv env`
2. `source env/bin/activate`
3. `pip install -e .`
4. `git submodule update --init --recursive`
5. `pip install -e umx`

## 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=umx_distortion`
or
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 scripts/train.py +exp=umx_distortion trainer.accelerator='gpu' trainer.devices=-1`

### Current Models
- `umx`
- `demucs`

### Current Effects
- `chorus`
- `compressor`
- `distortion`
- `reverb`

## Misc.
To skip rendering files, add `+datamodule.train_dataset.render_files=False +datamodule.val_dataset.render_files=False` to the command-line