add CLI ref

docs/source/demo.md

@@ -0,0 +1,16 @@
+# nkululeko.demo
+
+Module to generate predictions from unlabeled data using a pre-trained model.
+
+Usage:  
+```bash
+python -m nkululeko.demo --config my_config.ini --list my_testsamples.csv --outfile my_results.csv
+```
+
+Example of a configuration file:
+```ini
+[EXP]
+save = True
+[MODEL]
+save = True
+```

docs/source/index.rst

@@ -42,12 +42,20 @@ The examples only covers some important features of Nkululeko. For more details,
    hello_world_csv.md
    comparing
 
+.. toctree:: 
+   :maxdepth: 2
+   :caption: CLI Reference (modules)
+
+   nkululeko.md
+   test.md
+   demo.md
+
 
 .. toctree::
    :maxdepth: 1
    :caption: Function Reference
 
-   calfem_reference
+
 
 Indices and tables
 ==================

docs/source/nkululeko.md

@@ -0,0 +1,8 @@
+# nkululeko.nkululeko
+
+Module to run experiments with Nkululeko.
+
+Usage:
+```bash
+$ python -m nkululeko.nkululeko --config config_file.ini
+```

docs/source/test.md

@@ -0,0 +1,18 @@
+# nkululeko.test
+
+Module for testing the testing known datatast (has labels).  
+
+
+Usage:  
+```bash
+python -m nkululeko.test --config mycoonfg.ini --outfile myresults.csv
+```
+
+
+Example of `INI` file:  
+```ini
+[DATA]
+tests = ['my_testdb']
+my_testdb = /mypath/my_testdb
+...
+```

docs/source/usage.md

@@ -8,7 +8,7 @@ python -m nkululeko.[MODULE] --config [CONFIG_FILE.ini]
 python -m nkululeko.nkululeko --config INI_FILE.ini
 ```
 
-where [INI\_FILE.ini]{.title-ref} is a configuration file. The only file
+where [INI\_FILE.ini](ini_file.md) is a configuration file. The only file
 needed by the user is the INI file (after preparing the dataset).
 That\'s why we said this tool is intented without or less coding. The
 example of configuration file (INI\_FILE.ini) is given below. See [INI
@@ -32,15 +32,14 @@ type = ['os']
 type = xgb
 ```
 
-Besides [nkululeko.nkululeko]{.title-ref}, there are other functionalities. The completen functions are:
+Besides [nkululeko.nkululeko], there are other functionalities. The completen functions are:
 
-:   -   **nkululeko.nkululeko**: doing experiments
-    -   **nkululeko.demo**: demo the current best model on command line
-    -   **nkululeko.test**: predict a series of files with the current
-        best model
-    -   **nkululeko.explore**: perform data exploration
-    -   **nkululeko.augment**: augment the current training data
-    -   **nkululeko.predict**: predict a series of files with a given
-        model
+-   **nkululeko.nkululeko**: doing experiments
+-   **nkululeko.demo**: demo the current best model on command line
+-   **nkululeko.test**: predict a series of files with the current
+    best model
+-   **nkululeko.explore**: perform data exploration
+-   **nkululeko.augment**: augment the current training data
+-   **nkululeko.predict**: predict a series of files with a given model
 
-See the [API documentation](ini_file.md) for more details.
+See the CLI References (Modules) and [API documentation](ini_file.md) for more details.