diff options
| author | jvech <jmvalenciae@unal.edu.co> | 2023-09-03 21:05:32 -0500 |
|---|---|---|
| committer | jvech <jmvalenciae@unal.edu.co> | 2023-09-03 21:05:32 -0500 |
| commit | 82fbb56c97f41941b359b03c0033cb49295816f4 (patch) | |
| tree | 0b425196adc0e6a9676054007180b9156d97de7a /doc | |
| parent | bab6d665d98668f67686a3085d7de46204f67366 (diff) | |
doc: LICENSE and some documentation added
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ml.1 | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/ml.1 b/doc/ml.1 new file mode 100644 index 0000000..4329e80 --- /dev/null +++ b/doc/ml.1 @@ -0,0 +1,32 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. +.TH ML "1" "September 2023" "ml 0.1" "User Commands" +.SH NAME +ml \- manual page for ml 0.1 +.SH SYNOPSIS +.B ml +\fI\,train \/\fR[\fI\,Options\/\fR] \fI\,JSON_FILE\/\fR +.br +.B ml +\fI\,predict \/\fR[\fI\,-o FILE\/\fR] \fI\,FILE\/\fR +.SH DESCRIPTION +Train and predict json data +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Show this message +.TP +\fB\-a\fR, \fB\-\-alpha\fR=\fI\,ALPHA\/\fR +Learning rate (only works with train) +.TP +\fB\-e\fR, \fB\-\-epochs\fR=\fI\,EPOCHS\/\fR +Epochs to train the model (only works with train) +.TP +\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR +Output file (only works with predict) +.SH EXAMPLES +.IP +\f(CW$ ml train -e 150 -a 1e-4 housing.json\fR +.br +\f(CW$ ml predict housing.json -o predictions.json\fR +.SH AUTHOR +Written by vech |