Update README.md
This commit is contained in:
parent
cf19c6c86a
commit
300defd24a
1 changed files with 26 additions and 0 deletions
26
README.md
26
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)
|
||||
```
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue