Skip to content

Commit f2ec635

Browse files
committed
misc: small fix or general refactoring i did not bother commenting
1 parent 19c70cb commit f2ec635

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* determine how each of the input features affects the accuracy by differential training.
1717
* export a simple REST API to use your models from a server.
1818

19-
#### Installation
19+
### Installation
2020

2121
sudo pip3 install ergo-ai
2222

@@ -37,7 +37,7 @@ Download the [latest stable release](https://github.com/evilsocket/ergo/releases
3737
python3 setup.py build
3838
sudo python3 setup.py install
3939

40-
#### Usage
40+
### Creating a Project
4141

4242
Start by printing the available actions by running `ergo help`, you can also print the software version (ergo, keras
4343
and tensorflow versions) and some hardware info with `ergo info` to verify your installation.
@@ -56,6 +56,8 @@ By default, ergo will simply read the dataset as a CSV file, build a small neura
5656
each and 2 outputs and use a pretty standard training algorithm. **You can see a complete (and more complex) example on the [planes-detector](https://github.com/evilsocket/ergo-planes-detector)
5757
project repository**.
5858

59+
### Training
60+
5961
After defining the model structure and the training process, you can import a CSV dataset (first column must be the label) and start training using 2 GPUs:
6062

6163
ergo train example --dataset /some/path/data.csv --gpus 2
@@ -70,10 +72,16 @@ If you want to update a model and/or train it on already imported data, you can
7072

7173
ergo train example --gpus 2
7274

75+
### Testing and Inference
76+
7377
Now it's time to visualize the model structure and how the the `accuracy` and `loss` metrics changed during training (requires `sudo apt-get install graphviz python3-tk`):
7478

7579
ergo view example
7680

81+
You can use the `relevance` command to evaluate the model on a given set (or a subset of it, see `--ratio 0.1`) by nulling one attribute at a time and measuring how that influenced the accuracy (`feature.names` is an optional file with the names of the attributes, one per line):
82+
83+
ergo relevance example --dataset /some/path/data.csv --attributes /some/path/feature.names --ratio 0.1
84+
7785
Once you're done, you can remove the train, test and validation temporary datasets with:
7886

7987
ergo clean example
@@ -88,11 +96,7 @@ To reset the state of a project (**WARNING**: this will remove the datasets, the
8896

8997
ergo clean example --all
9098

91-
##### Other commands
92-
93-
You can use the `relevance` command to evaluate the model on a given set (or a subset of it, see `--ratio 0.1`) by nulling one attribute at a time and measuring how that influenced the accuracy (`feature.names` is an optional file with the names of the attributes, one per line):
94-
95-
ergo relevance example --dataset /some/path/data.csv --attributes /some/path/feature.names --ratio 0.1
99+
### Other commands
96100

97101
Evaluate and compare the performances of two trained models on a given dataset and (optionally) output the differences to a json file:
98102

@@ -110,7 +114,7 @@ Optimize a dataset (get unique rows and reuse 15% of the total samples, customiz
110114

111115
ergo optimize-dataset /some/path/data.csv
112116

113-
#### License
117+
### License
114118

115119
`ergo` was made with ♥ by [the dev team](https://github.com/evilsocket/ergo/graphs/contributors) and it is released under the GPL 3 license.
116120

0 commit comments

Comments
 (0)