[ML][DOCS] Refer to rules feature as custom rules (#32785)

This commit is contained in:
Dimitris Athanasiou 2018-08-13 14:51:13 +01:00 committed by GitHub
parent d147cd72cc
commit 4d2144a2a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 12 deletions

View File

@ -1,11 +1,11 @@
[role="xpack"] [role="xpack"]
[[ml-configuring-detector-custom-rules]] [[ml-configuring-detector-custom-rules]]
=== Customizing detectors with rules and filters === Customizing detectors with custom rules
<<ml-rules,Rules and filters>> enable you to change the behavior of anomaly <<ml-rules,Custom rules>> enable you to change the behavior of anomaly
detectors based on domain-specific knowledge. detectors based on domain-specific knowledge.
Rules describe _when_ a detector should take a certain _action_ instead Custom rules describe _when_ a detector should take a certain _action_ instead
of following its default behavior. To specify the _when_ a rule uses of following its default behavior. To specify the _when_ a rule uses
a `scope` and `conditions`. You can think of `scope` as the categorical a `scope` and `conditions`. You can think of `scope` as the categorical
specification of a rule, while `conditions` are the numerical part. specification of a rule, while `conditions` are the numerical part.
@ -14,7 +14,7 @@ scope and conditions.
Let us see how those can be configured by examples. Let us see how those can be configured by examples.
==== Specifying rule scope ==== Specifying custom rule scope
Let us assume we are configuring a job in order to detect DNS data exfiltration. Let us assume we are configuring a job in order to detect DNS data exfiltration.
Our data contain fields "subdomain" and "highest_registered_domain". Our data contain fields "subdomain" and "highest_registered_domain".
@ -127,7 +127,7 @@ PUT _xpack/ml/anomaly_detectors/scoping_multiple_fields
Such a detector will skip results when the values of all 3 scoped fields Such a detector will skip results when the values of all 3 scoped fields
are included in the referenced filters. are included in the referenced filters.
==== Specifying rule conditions ==== Specifying custom rule conditions
Imagine a detector that looks for anomalies in CPU utilization. Imagine a detector that looks for anomalies in CPU utilization.
Given a machine that is idle for long enough, small movement in CPU could Given a machine that is idle for long enough, small movement in CPU could
@ -206,9 +206,9 @@ PUT _xpack/ml/anomaly_detectors/rule_with_range
---------------------------------- ----------------------------------
// CONSOLE // CONSOLE
==== Rules in the life-cycle of a job ==== Custom rules in the life-cycle of a job
Rules only affect results created after the rules were applied. Custom rules only affect results created after the rules were applied.
Let us imagine that we have configured a job and it has been running Let us imagine that we have configured a job and it has been running
for some time. After observing its results we decide that we can employ for some time. After observing its results we decide that we can employ
rules in order to get rid of some uninteresting results. We can use rules in order to get rid of some uninteresting results. We can use
@ -216,7 +216,7 @@ the {ref}/ml-update-job.html[update job API] to do so. However, the rule we
added will only be in effect for any results created from the moment we added added will only be in effect for any results created from the moment we added
the rule onwards. Past results will remain unaffected. the rule onwards. Past results will remain unaffected.
==== Using rules VS filtering data ==== Using custom rules VS filtering data
It might appear like using rules is just another way of filtering the data It might appear like using rules is just another way of filtering the data
that feeds into a job. For example, a rule that skips results when the that feeds into a job. For example, a rule that skips results when the

View File

@ -13,4 +13,4 @@ A filter resource has the following properties:
`items`:: `items`::
(array of strings) An array of strings which is the filter item list. (array of strings) An array of strings which is the filter item list.
For more information, see {stack-ov}/ml-rules.html[Machine learning rules and filters]. For more information, see {stack-ov}/ml-rules.html[Machine learning custom rules].

View File

@ -18,7 +18,7 @@ Retrieves filters.
===== Description ===== Description
You can get a single filter or all filters. For more information, see You can get a single filter or all filters. For more information, see
{stack-ov}/ml-rules.html[Machine learning rules and filters]. {stack-ov}/ml-rules.html[Machine learning custom rules].
==== Path Parameters ==== Path Parameters

View File

@ -265,7 +265,7 @@ NOTE: The `field_name` cannot contain double quotes or backslashes.
when there is no value for the by or partition fields. The default value is `false`. when there is no value for the by or partition fields. The default value is `false`.
`custom_rules`:: `custom_rules`::
(array) An array of rule objects, which enable customizing how the detector works. (array) An array of custom rule objects, which enable customizing how the detector works.
For example, a rule may dictate to the detector conditions under which results should be skipped. For example, a rule may dictate to the detector conditions under which results should be skipped.
For more information see <<ml-detector-custom-rule,detector custom rule objects>>. + For more information see <<ml-detector-custom-rule,detector custom rule objects>>. +
+ +
@ -420,7 +420,7 @@ For more information, see
{stack-ov}/ml-rules.html[Custom rules] enable you to customize the way detectors {stack-ov}/ml-rules.html[Custom rules] enable you to customize the way detectors
operate. operate.
A rule has the following properties: A custom rule has the following properties:
`actions`:: `actions`::
(array) The set of actions to be triggered when the rule applies. (array) The set of actions to be triggered when the rule applies.