.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH ML "1" "August 2024" "ml 0.2.0" "User Commands"
.SH NAME
ml \- manual page for ml 0.2.0
.SH SYNOPSIS
.B ml
\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.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Show this message
.TP
\fB\-f\fR, \fB\-\-format\fR=\fI\,FORMAT\/\fR
Define input or output FILE format if needed
.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)
.TP
\fB\-O\fR, \fB\-\-only\-out\fR
Don't show input fields (only works with predict)
.TP
\fB\-c\fR, \fB\-\-config\fR=\fI\,FILE\/\fR
Configuration filepath [default=~/.config/ml/ml.cfg]
.TP
\fB\-p\fR, \fB\-\-precision\fR=\fI\,INT\/\fR
Decimals output precision (only works with predict)
[default=auto]
.SH FILES
~/.config/ml/ml.cfg
    File path for network configuration, here you can setup the network
    architecture and its training parameters
.SH EXAMPLES

Train a network to solve XOR problem, below is the training data:

    [
      {
        "x": 0,
        "y": 0,
        "z": 0
      },
      {
        "x": 1,
        "y": 0,
        "z": 1
      },
      {
        "x": 0,
        "y": 1,
        "z": 1
      },
      {
        "x": 1,
        "y": 1,
        "z": 0
      }
    ]

Use the default configuration file and train the model with:
    $ ml train -e 150 xor.json

And get the network output using:
    $ ml predict xor.json 
.SH AUTHOR
Written by jvech
.SH COPYRIGHT
Copyright \(co 2023  jvech
.PP
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.