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

index 2cc2ac9bfb27233a7be17389d2e2725dc8d20d51..8d00c3a83510355190d6b5a526d030386e5fc9eb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,3 +2,15 @@
 Takes cruddy conference call audio and upsamples it to HD Audio
 
 To read more about the research, visit https://crimata.com/AIPost
+
+## Usage
+
+Repository Structure
+
+* `./data`: the data and the metadata (you should not need to touch this folder)
+* `./main`: the model and its respective utilites
+* `./samples`: audio files and spectrograms generated from the neural net
+
+```
+python 3 main.py -h
+```