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

Update README.md
---

diff --git a/README.md b/README.md
index 8d00c3a..8fedb28 100644
--- a/README.md
+++ b/README.md
@@ -12,5 +12,31 @@ Repository Structure
 * `./samples`: audio files and spectrograms generated from the neural net
 
 ```
+cd ./main
 python 3 main.py -h
 ```
+
+It will then ask you if you'd like to train or evaluate.  To get help for each respectivly, just type:
+
+```
+python 3 main.py train -h
+python 3 main.py eval -h
+```
+
+Argument Reference:
+
+'''
+Arguments:
+  -h, --help        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)
+```
+