aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9baa0ac..1e53f55 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,9 @@ A simple neural network maker developed to train json data
```
git clone https://git.juanvalencia.xyz/ml
cd ml
+make
sudo make install
+make install_config
```
## Uninstall
@@ -22,16 +24,18 @@ sudo make uninstall
```
## Usage
+
```
Usage: ml train [Options] JSON_FILE
or: ml predict [-o FILE] FILE
-Train and predict json data
Options:
-h, --help Show this message
-a, --alpha=ALPHA Learning rate (only works with train)
-e, --epochs=EPOCHS Epochs to train the model (only works with train)
-o, --output=FILE Output file (only works with predict)
+ -c, --config=FILE Configuration filepath [default=~/.config/ml/ml.cfg]
+
Examples:
$ ml train -e 150 -a 1e-4 housing.json
Feel free to download, copy and edit any repo