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

Update README.md
---

diff --git a/README.md b/README.md
index f78d9b3..9cee606 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ 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
+### Repository Structure
 
 * `./data`: the data and the metadata (you should not need to touch this folder)
 * `./main`: the model and its respective utilites
@@ -27,7 +27,7 @@ python 3 main.py train -h
 python 3 main.py eval -h
 ```
 
-Argument Reference | train
+### Argument Reference | train
 
 ```
 -h, --help        
@@ -43,7 +43,13 @@ Argument Reference | train
 -n MIN_LR         min learning rate (only for SGDR)
 ```
 
-Argument Reference | eval
+Example
+```
+python3 main.py train \
+  -i 1 -c false -k True -d 8192 -x 100 -e 10 -b 32
+```
+
+### Argument Reference | eval
 
 ```
 -h, --help
@@ -56,12 +62,6 @@ Argument Reference | eval
 -c FROM_CKPT      bool, begin eval at last checkpoint
 ```
 
-Example | train
-```
-python3 main.py train \
-  -i 1 -c false -k True -d 8192 -x 100 -e 10 -b 32
-```
-
 Example | eval
 ```
 python3 main.py train \