mattricesound commited on
Commit
12e94ae
1 Parent(s): 1395200

Update README

Browse files
Files changed (1) hide show
  1. README.md +2 -2
README.md CHANGED
@@ -36,7 +36,7 @@ export DATASET_ROOT={path/to/datasets}
36
  ```
37
 
38
  ## Training
39
- Before training, it is important that you have downloaded the starter datasets (see above) and set DATASET_ROOT.
40
  This project uses the [pytorch-lightning](https://www.pytorchlightning.ai/index.html) framework and [hydra](https://hydra.cc/) for configuration management. All experiments are defined in `cfg/exp/`. To train with an existing experiment run
41
  ```
42
  python scripts/train.py +exp={experiment_name}
@@ -103,7 +103,7 @@ Metrics and hyperparams will be logged in `./lightning_logs/{timestamp}`
103
  ## Generate other datasets
104
  The datasets used in the experiments are customly generated from the starter datasets. In short, for each training/val/testing example, we select a random 5.5s segment from one of the starter datasets and apply a random number of effects to it. The number of effects applied is controlled by the `num_kept_effects` and `num_removed_effects` parameters. The effects applied are controlled by the `effects_to_keep` and `effects_to_remove` parameters.
105
 
106
- Before generating datasets, it is important that you have downloaded the starter datasets (see above) and set DATASET_ROOT.
107
 
108
  To generate one of the datasets used in the paper, use of the experiments defined in `cfg/exp/`.
109
  For example, to generate the `chorus` FXAug dataset, which includes files with 5 possible effects, up to 4 kept effects (distortion, reverb, compression, delay), and 1 removed effects (chorus), run
 
36
  ```
37
 
38
  ## Training
39
+ Before training, it is important that you have downloaded the starter datasets (see above) and set `$DATASET_ROOT`.
40
  This project uses the [pytorch-lightning](https://www.pytorchlightning.ai/index.html) framework and [hydra](https://hydra.cc/) for configuration management. All experiments are defined in `cfg/exp/`. To train with an existing experiment run
41
  ```
42
  python scripts/train.py +exp={experiment_name}
 
103
  ## Generate other datasets
104
  The datasets used in the experiments are customly generated from the starter datasets. In short, for each training/val/testing example, we select a random 5.5s segment from one of the starter datasets and apply a random number of effects to it. The number of effects applied is controlled by the `num_kept_effects` and `num_removed_effects` parameters. The effects applied are controlled by the `effects_to_keep` and `effects_to_remove` parameters.
105
 
106
+ Before generating datasets, it is important that you have downloaded the starter datasets (see above) and set `$DATASET_ROOT`.
107
 
108
  To generate one of the datasets used in the paper, use of the experiments defined in `cfg/exp/`.
109
  For example, to generate the `chorus` FXAug dataset, which includes files with 5 possible effects, up to 4 kept effects (distortion, reverb, compression, delay), and 1 removed effects (chorus), run