Update README.md

This commit is contained in:
Andrew Gundersen 2020-02-17 17:27:58 -06:00 committed by GitHub
commit 300defd24a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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)
```