diff options
author | jvech <jmvalenciae@unal.edu.co> | 2024-08-07 10:06:35 -0500 |
---|---|---|
committer | jvech <jmvalenciae@unal.edu.co> | 2024-08-07 10:06:35 -0500 |
commit | 65926438256c1ed46993e1c8611597af5a9c23f1 (patch) | |
tree | 10ab13854190156bc25bd7586256fe8b224e2613 /README.md | |
parent | ebd66e65bf18574fa8905d7b0ae3fbb85bfc9e06 (diff) |
add: CLI improvements and small documentation updates
Things done:
* config path should search config file in the following order: cli
option, environment, xdg_path
* Implement a retrain command.
* when you require more keys than the ones available in the input,
stop the program.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -26,15 +26,20 @@ sudo make uninstall ## Usage ``` -Usage: ml train [Options] JSON_FILE - or: ml predict [-o FILE] FILE +Usage: ml [re]train [Options] FILE + or: ml predict [-Ohv] [-f FORMAT] [-o FILE] [-p INT] FILE Options: -h, --help Show this message + -f, --format=FORMAT Define input or output FILE format if needed -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) + -O, --only-out Don't show input fields (only works with predict) -c, --config=FILE Configuration filepath [default=~/.config/ml/ml.cfg] + -p, --precision=INT Decimals output precision (only works with predict) + [default=auto] + Examples: |