aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1e53f55a7b0b527d6464a1e4e217551b2f776aa5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# ML

A simple neural network maker developed to train json data

## Requirements

* [openblas](https://www.openblas.net)
* [json-c](https://github.com/json-c/json-c)

## Installation

```
git clone https://git.juanvalencia.xyz/ml
cd ml
make
sudo make install
make install_config
```

## Uninstall

```
sudo make uninstall
```

## Usage

```
Usage: ml train [Options] JSON_FILE
   or: ml predict [-o FILE] FILE

Options:
  -h, --help               Show this message
  -a, --alpha=ALPHA        Learning rate (only works with train)
  -e, --epochs=EPOCHS      Epochs to train the model (only works with train)
  -o, --output=FILE        Output file (only works with predict)
  -c, --config=FILE        Configuration filepath [default=~/.config/ml/ml.cfg]


Examples:
  $ ml train -e 150 -a 1e-4 housing.json
  $ ml predict housing.json -o predictions.json
```
Feel free to download, copy and edit any repo