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 /doc/ml.1 | |
| 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 'doc/ml.1')
| -rw-r--r-- | doc/ml.1 | 9 |
1 files changed, 6 insertions, 3 deletions
@@ -4,13 +4,13 @@ ml \- manual page for ml 0.2.0 .SH SYNOPSIS .B ml -\fI\,train \/\fR[\fI\,Options\/\fR] \fI\,FILE\/\fR +[\fI\,re\/\fR]\fI\,train \/\fR[\fI\,Options\/\fR] \fI\,FILE\/\fR .br .B ml \fI\,predict \/\fR[\fI\,-Ohv\/\fR] [\fI\,-f FORMAT\/\fR] [\fI\,-o FILE\/\fR] [\fI\,-p INT\/\fR] \fI\,FILE\/\fR .SH DESCRIPTION -ml is a simple neural network maker made to train and predict JSON data, -it is suitable to work on classification problems. +ml is a simple neural network maker made to train and predict over JSON, CSV +and TSV data, it is suitable to work on classification problems. .SH OPTIONS .TP \fB\-h\fR, \fB\-\-help\fR @@ -37,6 +37,9 @@ Configuration filepath [default=~/.config/ml/ml.cfg] \fB\-p\fR, \fB\-\-precision\fR=\fI\,INT\/\fR Decimals output precision (only works with predict) [default=auto] +.SH ENVIRONMENT +ML_CONFIG_PATH + Set the configuration filepath .SH FILES ~/.config/ml/ml.cfg File path for network configuration, here you can setup the network |