From 17b2cf8dc274f950865911185fc4c6a9ccf915d5 Mon Sep 17 00:00:00 2001
From: jvech <jmvalenciae@unal.edu.co>
Date: Sat, 21 Oct 2023 21:43:36 -0500
Subject: setup: man page improved

Documentation:
    Example sections was improved
    Files sections was added

Fixes:
    default config filepath was fixed
---
 doc/ml.1 | 47 +++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 41 insertions(+), 6 deletions(-)

(limited to 'doc')

diff --git a/doc/ml.1 b/doc/ml.1
index dee805c..babac62 100644
--- a/doc/ml.1
+++ b/doc/ml.1
@@ -9,7 +9,8 @@ ml \- manual page for ml 0.1
 .B ml
 \fI\,predict \/\fR[\fI\,-o FILE\/\fR] \fI\,FILE\/\fR
 .SH DESCRIPTION
-Train and predict json data
+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
@@ -23,13 +24,47 @@ 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\-c\fR, \fB\-\-config\fR=\fI\,FILE\/\fR
+Configuration filepath [default=~/.config/ml/ml.cfg]
+.SH FILES
+~/.config/ml/ml.cfg
+    File path for network configuration, here you can setup the network
+    architecture and its training parameters
 .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
+
+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 vech
+Written by jvech
 .SH COPYRIGHT
 Copyright \(co 2023  jvech
 .PP
-- 
cgit v1.2.3-70-g09d2