Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Adds overview for machine learning rules and filters #84

Merged
merged 3 commits into from
Jul 24, 2018

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 19, 2018

Related to elastic/elasticsearch#32013

This PR adds a brief conceptual introduction of machine learning rules and filters in the Stack Overview.

Copy link
Contributor

@dimitris-athanasiou dimitris-athanasiou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Left a couple of minor comments.

_Rules_ instruct anomaly detectors to change their behavior based on
domain-specific knowledge that you provide. When you create a rule, you can
specify conditions, scope, and actions. By default, the scope of a rule is
unlimited and you must specify at least one condition. When the conditions of a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be a bit misleading as if scope is specified there could be no conditions.

domain-specific knowledge that you provide. When you create a rule, you can
specify conditions, scope, and actions. By default, the scope of a rule is
unlimited and you must specify at least one condition. When the conditions of a
rule are satisfied, its action is triggered.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its action is triggered -> its actions are triggered

rule are satisfied, its action is triggered.

For example, if you have an anomaly detector that is analyzing CPU usage, you
might decide you are only interested in abnormally high usage. You can define a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

abnormally high usage takes my mind to simply using a high variant of a function. I think it might be better to say something like "you might decide you are only interested in anomalies where the CPU usage is greater than a certain threshold".

@lcawl
Copy link
Contributor Author

lcawl commented Jul 23, 2018

Thanks @dimitris-athanasiou, I've refreshed the preview with updates based on your comments.

Copy link
Contributor

@dimitris-athanasiou dimitris-athanasiou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lcawl lcawl merged commit 2993232 into elastic:master Jul 24, 2018
@lcawl lcawl deleted the lcawley-rules branch July 24, 2018 17:08
@lcawl
Copy link
Contributor Author

lcawl commented Jul 24, 2018

Backported to 6.x via 9a7fbbf

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants