From: Andrew Gundersen <53452154+gundersena@users.noreply.github.com>
Date: Mon, 17 Feb 2020 23:37:41 +0000 (-0600)
Subject: Update README.md
X-Git-Url: https://andrewgundersen.net/repos?a=commitdiff_plain;h=7cfb8e071d6f3280cb5dd5599c6038d1d670b0ea;p=ml-audio-enhancer

Update README.md
---

diff --git a/README.md b/README.md
index ca6e973..7372e36 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,10 @@ To read more about the research, visit https://crimata.com/AIPost
 
 ## Usage
 
+Clone the repo.
+
+Download dataset at https://homepages.inf.ed.ac.uk/jyamagis/page3/page58/page58.html and place it in the data folder.
+
 Repository Structure
 
 * `./data`: the data and the metadata (you should not need to touch this folder)
@@ -26,31 +30,29 @@ python 3 main.py eval -h
 Argument Reference | train
 
 ```
-Arguments:
-  -h, --help        
-  -i MODEL_ID       an index you can add to querey the model later
-  -c FROM_CKPT      bool, begin training session from a checkpoint
-  -k NEW_DATA       bool, make new set of data
-  -d DIM_SIZE       size of each audio sample
-  -x NUM_FILES      number of files to train
-  -e EPOCHS
-  -b BATCH_SIZE
-  -o CYCLE_LENGTH   length of cycle in epochs (only for SGDR)
-  -m MAX_LR         max learning rate (only for SGDR)
-  -n MIN_LR         min learning rate (only for SGDR)
+-h, --help        
+-i MODEL_ID       an index you can add to querey the model later
+-c FROM_CKPT      bool, begin training session from a checkpoint
+-k NEW_DATA       bool, make new set of data
+-d DIM_SIZE       size of each audio sample
+-x NUM_FILES      number of files to train
+-e EPOCHS
+-b BATCH_SIZE
+-o CYCLE_LENGTH   length of cycle in epochs (only for SGDR)
+-m MAX_LR         max learning rate (only for SGDR)
+-n MIN_LR         min learning rate (only for SGDR)
 ```
 
 Argument Reference | eval
 
 ```
-Arguments:
-  -h, --help
-  -i MODEL_ID       model ID to use
-  -n NUM_EXAMPLES   number of examples/files to run
-  -w WAVFILE_LIST   list to pull examples from
-  -r SCALE          level of upsampling
-  -s SAMPLE_RATE    target sample rate
-  -a MAKE_AUDIO     bool, make audio or just spectrograms
-  -c FROM_CKPT      bool, begin eval at last checkpoint
+-h, --help
+-i MODEL_ID       model ID to use
+-n NUM_EXAMPLES   number of examples/files to run
+-w WAVFILE_LIST   list to pull examples from
+-r SCALE          level of upsampling
+-s SAMPLE_RATE    target sample rate
+-a MAKE_AUDIO     bool, make audio or just spectrograms
+-c FROM_CKPT      bool, begin eval at last checkpoint
 ```