]> Repos - ml-audio-enhancer/commitdiff
Update README.md
authorAndrew Gundersen <53452154+gundersena@users.noreply.github.com>
Mon, 17 Feb 2020 23:58:15 +0000 (17:58 -0600)
committerGitHub <noreply@github.com>
Mon, 17 Feb 2020 23:58:15 +0000 (17:58 -0600)
README.md

index f78d9b33a87b0958b06f8a9c9eca758e627d0823..9cee606de4b55cef3287faf0d07bcf19b9385658 100644 (file)
--- 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 \