make configuration example clearer (#13182)
make ml configuration example cleare
Andrew Maguire committed
Jun 25, 2022 at 16:12 UTC
d40cb1e446b2a25ea9f14502b3aa8e33825889ba
1 file changed
+14
-23
ml/README.md
+14
-23
@@ -183,43 +183,34 @@ Below is a list of all the available configuration params and their default valu
183
184
If you would like to run ML on a parent instead of at the edge, some configuration options are illustrated below.
185
186
-This example assumes 3 child nodes [streaming](https://learn.netdata.cloud/docs/agent/streaming) to 1 parent node and illustrates the main ways you might want to configure running ml for the children on the parent, running ML on the children themselves, or even a mix of approaches.
186
+This example assumes 3 child nodes [streaming](https://learn.netdata.cloud/docs/agent/streaming) to 1 parent node and illustrates the main ways you might want to configure running ML for the children on the parent, running ML on the children themselves, or even a mix of approaches.
187
188
189
190
```
191
-# parent will run ml for itself and child 1,2.
192
-# child 0 will run its own ml at the edge and just stream its ml charts to parent.
193
-# child 1 will run its own ml at the edge, even though parent will also run ml for it, a bit wasteful potentially to run ml in both places but is possible.
194
-# child 2 will not run ml at the edge, it will be run in the parent only.
191
+# parent will run ML for itself and child 1,2, it will skip running ML for child 0.
192
+# child 0 will run its own ML at the edge.
193
+# child 1 will run its own ML at the edge, even though parent will also run ML for it, a bit wasteful potentially to run ML in both places but is possible (Netdata Cloud will essentially average any overlapping models).
194
+# child 2 will not run ML at the edge, it will be run in the parent only.
195
196
-# parent-ml-ml-stress-0
197
-# run ml on all hosts apart from child-ml-ml-stress-0
196
+# parent-ml-enabled
197
+# run ML on all hosts apart from child-ml-enabled
198
[ml]
199
enabled = yes
200
- minimum num samples to train = 900
201
- train every = 900
202
- charts to skip from training = !*
203
- hosts to skip from training = child-ml-ml-stress-0
200
+ hosts to skip from training = child-0-ml-enabled
201
205
-# child-ml-ml-stress-0
206
-# run ml on child-ml-ml-stress-0 and stream ml charts to parent
202
+# child-0-ml-enabled
203
+# run ML on child-0-ml-enabled
204
[ml]
205
enabled = yes
209
- minimum num samples to train = 900
210
- train every = 900
211
- stream anomaly detection charts = yes
206
213
-# child-ml-ml-stress-1
214
-# run ml on child-ml-ml-stress-1 and stream ml charts to parent
207
+# child-1-ml-enabled
208
+# run ML on child-1-ml-enabled
209
[ml]
210
enabled = yes
217
- minimum num samples to train = 900
218
- train every = 900
219
- stream anomaly detection charts = yes
211
221
-# child-ml-ml-stress-2
222
-# don't run ml on child-ml-ml-stress-2, it will instead run on parent-ml-ml-stress-0
212
+# child-2-ml-disabled
213
+# do not run ML on child-2-ml-disabled
214
[ml]
215
enabled = no
216
```