Skip to content

Commit 1eda83d

Browse files
committed
[DOCS] Adds bucket results section and detail (#764)
1 parent 8104d17 commit 1eda83d

File tree

4 files changed

+17
-8
lines changed

4 files changed

+17
-8
lines changed

docs/en/stack/ml/anomaly-detection/buckets.asciidoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
<titleabbrev>Buckets</titleabbrev>
66
++++
77

8-
The {ml-features} use the concept of a _bucket_ to divide the time series
9-
into batches for processing.
8+
The {ml-features} use the concept of a _bucket_ to divide the time series into
9+
batches for processing.
1010

1111
The _bucket span_ is part of the configuration information for an {anomaly-job}.
1212
It defines the time interval that is used to summarize and model the data. This
@@ -15,9 +15,13 @@ characteristics. When you set the bucket span, take into account the granularity
1515
at which you want to analyze, the frequency of the input data, the typical
1616
duration of the anomalies, and the frequency at which alerting is required.
1717

18+
[discrete]
19+
[[ml-bucket-results]]
20+
==== Bucket results
21+
1822
When you view your {ml} results, each bucket has an anomaly score. This score is
1923
a statistically aggregated and normalized view of the combined anomalousness of
20-
all the record results in the bucket.
24+
all the record results in the bucket.
2125

2226
The {ml} analytics enhance the anomaly score for each bucket by considering
2327
contiguous buckets. This extra _multi-bucket analysis_ effectively uses a
@@ -35,9 +39,14 @@ In this example, you can see that some of the anomalies fall within the shaded
3539
blue area, which represents the bounds for the expected values. The bounds are
3640
calculated per bucket, but multi-bucket analysis is not limited by that scope.
3741

38-
If you have more than one {anomaly-job}, you can also obtain overall bucket
42+
If you have more than one {anomaly-job}, you can also obtain _overall bucket_
3943
results, which combine and correlate anomalies from multiple jobs into an
4044
overall score. When you view the results for job groups in {kib}, it provides
4145
the overall bucket scores. For more information, see
42-
{ref}/ml-results-resource.html[Results resources] and
4346
{ref}/ml-get-overall-buckets.html[Get overall buckets API].
47+
48+
Bucket results provide the top level, overall view of the {anomaly-job} and are
49+
ideal for alerts. For example, the bucket results might indicate that at 16:05
50+
the system was unusual. This information is a summary of all the anomalies,
51+
pinpointing when they occurred. When you identify an anomalous bucket, you can
52+
investigate further by examining the pertinent records.

docs/en/stack/ml/anomaly-detection/create-jobs.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[create-jobs]]
3-
=== Creating {anomaly-jobs}
3+
=== Create {anomaly-jobs}
44

55
{anomaly-jobs-cap} contain the configuration information and metadata
66
necessary to perform an analytics task.

docs/en/stack/ml/anomaly-detection/ml-configuration.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-configuration]]
3-
== Configuring {anomaly-detect}
3+
== Configure {anomaly-detect}
44

55
If you want to use {ml-features}, there must be at least one {ml} node in
66
your cluster and all master-eligible nodes must have {ml} enabled. By default,

docs/en/stack/ml/anomaly-detection/stopping-ml.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[stopping-ml]]
3-
=== Stopping {ml} {anomaly-detect}
3+
=== Stop {ml} {anomaly-detect}
44

55
An orderly shutdown ensures that:
66

0 commit comments

Comments
 (0)