You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-8Lines changed: 12 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@
16
16
* determine how each of the input features affects the accuracy by differential training.
17
17
* export a simple REST API to use your models from a server.
18
18
19
-
####Installation
19
+
### Installation
20
20
21
21
sudo pip3 install ergo-ai
22
22
@@ -37,7 +37,7 @@ Download the [latest stable release](https://github.com/evilsocket/ergo/releases
37
37
python3 setup.py build
38
38
sudo python3 setup.py install
39
39
40
-
#### Usage
40
+
###Creating a Project
41
41
42
42
Start by printing the available actions by running `ergo help`, you can also print the software version (ergo, keras
43
43
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
56
56
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)
57
57
project repository**.
58
58
59
+
### Training
60
+
59
61
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:
60
62
61
63
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
70
72
71
73
ergo train example --gpus 2
72
74
75
+
### Testing and Inference
76
+
73
77
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`):
74
78
75
79
ergo view example
76
80
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
+
77
85
Once you're done, you can remove the train, test and validation temporary datasets with:
78
86
79
87
ergo clean example
@@ -88,11 +96,7 @@ To reset the state of a project (**WARNING**: this will remove the datasets, the
88
96
89
97
ergo clean example --all
90
98
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
96
100
97
101
Evaluate and compare the performances of two trained models on a given dataset and (optionally) output the differences to a json file:
98
102
@@ -110,7 +114,7 @@ Optimize a dataset (get unique rows and reuse 15% of the total samples, customiz
110
114
111
115
ergo optimize-dataset /some/path/data.csv
112
116
113
-
####License
117
+
### License
114
118
115
119
`ergo` was made with ♥ by [the dev team](https://github.com/evilsocket/ergo/graphs/contributors) and it is released under the GPL 3 license.
0 commit comments