Skip to content

Commit 16d84da

Browse files
committed
Updates anomaly detection job terminology in Stack Overview (#444)
1 parent 47d9ca9 commit 16d84da

File tree

9 files changed

+61
-60
lines changed

9 files changed

+61
-60
lines changed

docs/en/stack/ml/anomaly-detection/api-quickref.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
[[ml-api-quickref]]
33
== API quick reference
44

5-
All {ml} endpoints have the following base:
5+
All {ml} {anomaly-detect} endpoints have the following base:
66

77
[source,js]
88
----
99
/_ml/
1010
----
1111
// NOTCONSOLE
1212

13-
The main {ml} resources can be accessed with a variety of endpoints:
13+
The main resources can be accessed with a variety of endpoints:
1414

1515
* {ref}/ml-apis.html#ml-api-job-endpoint[+/anomaly_detectors/+]: Create and manage {anomaly-jobs}
1616
* {ref}/ml-apis.html#ml-api-calendar-endpoint[+/calendars/+]: Create and manage calendars and scheduled events
@@ -19,4 +19,4 @@ The main {ml} resources can be accessed with a variety of endpoints:
1919
* {ref}/ml-apis.html#ml-api-result-endpoint[+/results/+]: Access the results of an {anomaly-job}
2020
* {ref}/ml-apis.html#ml-api-snapshot-endpoint[+/model_snapshots/+]: Manage model snapshots
2121

22-
For a full list, see {ref}/ml-apis.html[Machine learning APIs].
22+
For a full list, see {ref}/ml-apis.html[{ml-cap} {anomaly-detect} APIs].

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

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,18 @@
88
The {ml-features} use the concept of a _bucket_ to divide the time series
99
into batches for processing.
1010

11-
The _bucket span_ is part of the configuration information for a job. It defines
12-
the time interval that is used to summarize and model the data. This is
13-
typically between 5 minutes to 1 hour and it depends on your data characteristics.
14-
When you set the bucket span, take into account the granularity at which you
15-
want to analyze, the frequency of the input data, the typical duration of the
16-
anomalies, and the frequency at which alerting is required.
11+
The _bucket span_ is part of the configuration information for an {anomaly-job}.
12+
It defines the time interval that is used to summarize and model the data. This
13+
is typically between 5 minutes to 1 hour and it depends on your data
14+
characteristics. When you set the bucket span, take into account the granularity
15+
at which you want to analyze, the frequency of the input data, the typical
16+
duration of the anomalies, and the frequency at which alerting is required.
1717

1818
When you view your {ml} results, each bucket has an anomaly score. This score is
1919
a statistically aggregated and normalized view of the combined anomalousness of
2020
all the record results in the bucket.
2121

22-
In 6.5 and later releases, the {ml} analytics enhance the anomaly score for each
23-
bucket by considering
24-
//TBD: preceding?
22+
The {ml} analytics enhance the anomaly score for each bucket by considering
2523
contiguous buckets. This extra _multi-bucket analysis_ effectively uses a
2624
sliding window to evaluate the events in each bucket relative to the larger
2725
context of recent events. When you review your {ml} results, there is a
@@ -37,9 +35,9 @@ In this example, you can see that some of the anomalies fall within the shaded
3735
blue area, which represents the bounds for the expected values. The bounds are
3836
calculated per bucket, but multi-bucket analysis is not limited by that scope.
3937

40-
If you have more than one job, you can
41-
also obtain overall bucket results, which combine and correlate anomalies from
42-
multiple jobs into an overall score. When you view the results for job groups
43-
in {kib}, it provides the overall bucket scores. For more information, see
38+
If you have more than one {anomaly-job}, you can also obtain overall bucket
39+
results, which combine and correlate anomalies from multiple jobs into an
40+
overall score. When you view the results for job groups in {kib}, it provides
41+
the overall bucket scores. For more information, see
4442
{ref}/ml-results-resource.html[Results resources] and
4543
{ref}/ml-get-overall-buckets.html[Get overall buckets API].

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,18 @@ identify these events in advance, no anomalies are generated during that period.
88
The {ml} model is not ill-affected and you do not receive spurious results.
99

1010
You can create calendars and scheduled events in the **Settings** pane on the
11-
**Machine Learning** page in {kib} or by using {ref}/ml-apis.html[{ml} APIs].
11+
**Machine Learning** page in {kib} or by using
12+
{ref}/ml-apis.html[{ml-cap} {anomaly-detect} APIs].
1213

1314
A scheduled event must have a start time, end time, and description. In general,
1415
scheduled events are short in duration (typically lasting from a few hours to a
1516
day) and occur infrequently. If you have regularly occurring events, such as
1617
weekly maintenance periods, you do not need to create scheduled events for these
1718
circumstances; they are already handled by the {ml} analytics.
1819

19-
You can identify zero or more scheduled events in a calendar. Jobs can then
20-
subscribe to calendars and the {ml} analytics handle all subsequent scheduled
21-
events appropriately.
20+
You can identify zero or more scheduled events in a calendar. {anomaly-jobs-cap}
21+
can then subscribe to calendars and the {ml} analytics handle all subsequent
22+
scheduled events appropriately.
2223

2324
If you want to add multiple scheduled events at once, you can import an
2425
iCalendar (`.ics`) file in {kib} or a JSON file in the
@@ -27,13 +28,13 @@ iCalendar (`.ics`) file in {kib} or a JSON file in the
2728
[NOTE]
2829
--
2930

30-
* You must identify scheduled events before your job analyzes the data for that
31-
time period. Machine learning results are not updated retroactively.
31+
* You must identify scheduled events before your {anomaly-job} analyzes the data
32+
for that time period. Machine learning results are not updated retroactively.
3233
* If your iCalendar file contains recurring events, only the first occurrence is
3334
imported.
3435
* Bucket results are generated during scheduled events but they have an
3536
anomaly score of zero. For more information about bucket results, see
36-
{ref}/ml-results-resource.html[Results Resources].
37+
{ref}/ml-results-resource.html[Results resources].
3738
* If you use long or frequent scheduled events, it might take longer for the
3839
{ml} analytics to learn to model your data and some anomalous behavior might be
3940
missed.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
[[ml-dfeeds]]
33
=== {dfeeds-cap}
44

5-
Machine learning jobs can analyze data that is stored in {es} or data that is
5+
{anomaly-jobs-cap} can analyze data that is stored in {es} or data that is
66
sent from some other source via an API. _{dfeeds-cap}_ retrieve data from {es}
77
for analysis, which is the simpler and more common scenario.
88

9-
If you create jobs in {kib}, you must use {dfeeds}. When you create a job, you
10-
select an index pattern and {kib} configures the {dfeed} for you under the
11-
covers. If you use {ml} APIs instead, you can create a {dfeed} by using the
12-
{ref}/ml-put-datafeed.html[create {dfeeds} API] after you create a job. You can
13-
associate only one {dfeed} with each job.
9+
If you create {anomaly-jobs} in {kib}, you must use {dfeeds}. When you create a
10+
job, you select an index pattern and {kib} configures the {dfeed} for you under
11+
the covers. If you use APIs instead, you can create a {dfeed} by using the
12+
{ref}/ml-put-datafeed.html[create {dfeeds} API] after you create an
13+
{anomaly-job}. You can associate only one {dfeed} with each job.
1414

1515
For a description of all the {dfeed} properties, see
16-
{ref}/ml-datafeed-resource.html[Datafeed Resources].
16+
{ref}/ml-datafeed-resource.html[Datafeed resources].
1717

1818
To start retrieving data from {es}, you must start the {dfeed}. When you start
1919
it, you can optionally specify start and end times. If you do not specify an

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ your disk utilization will reach 100% before the end of next week.
1515

1616
Each forecast has a unique ID, which you can use to distinguish between forecasts
1717
that you created at different times. You can create a forecast by using the
18-
{ref}/ml-forecast.html[Forecast Jobs API] or by using {kib}. For example:
18+
{ref}/ml-forecast.html[forecast {anomaly-jobs} API] or by using {kib}. For
19+
example:
1920

2021

2122
[role="screenshot"]
@@ -34,19 +35,17 @@ Eventually if the confidence levels are too low, the forecast stops.
3435
You can also optionally specify when the forecast expires. By default, it
3536
expires in 14 days and is deleted automatically thereafter. You can specify a
3637
different expiration period by using the `expires_in` parameter in the
37-
{ref}/ml-forecast.html[Forecast Jobs API].
38-
39-
//Add examples of forecast_request_stats and forecast documents?
38+
{ref}/ml-forecast.html[forecast {anomaly-jobs} API].
4039

4140
There are some limitations that affect your ability to create a forecast:
4241

4342
* You can generate only three forecasts concurrently. There is no limit to the
4443
number of forecasts that you retain. Existing forecasts are not overwritten when
4544
you create new forecasts. Rather, they are automatically deleted when they expire.
46-
* If you use an `over_field_name` property in your job (that is to say, it's a
47-
_population job_), you cannot create a forecast.
48-
* If you use any of the following analytical functions in your job, you
49-
cannot create a forecast:
45+
* If you use an `over_field_name` property in your {anomaly-job} (that is to say,
46+
it's a _population job_), you cannot create a forecast.
47+
* If you use any of the following analytical functions in your {anomaly-job},
48+
you cannot create a forecast:
5049
** `lat_long`
5150
** `rare` and `freq_rare`
5251
** `time_of_day` and `time_of_week`
@@ -56,9 +55,10 @@ For more information about any of these functions, see <<ml-functions>>.
5655
--
5756
* Forecasts run concurrently with real-time {ml} analysis. That is to say, {ml}
5857
analysis does not stop while forecasts are generated. Forecasts can have an
59-
impact on {ml} jobs, however, especially in terms of memory usage. For this
58+
impact on {anomaly-jobs}, however, especially in terms of memory usage. For this
6059
reason, forecasts run only if the model memory status is acceptable.
61-
* The job must be open when you create a forecast. Otherwise, an error occurs.
60+
* The {anomaly-job} must be open when you create a forecast. Otherwise, an error
61+
occurs.
6262
* If there is insufficient data to generate any meaningful predictions, an
6363
error occurs. In general, forecasts that are created early in the learning phase
6464
of the data analysis are less accurate.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[role="xpack"]
22
[[ml-jobs]]
3-
=== Machine learning jobs
3+
=== {anomaly-jobs-cap}
44
++++
55
<titleabbrev>Jobs</titleabbrev>
66
++++
77

8-
Machine learning jobs contain the configuration information and metadata
8+
{anomaly-jobs-cap} contain the configuration information and metadata
99
necessary to perform an analytics task.
1010

11-
Each job has one or more _detectors_. A detector applies an analytical function
12-
to specific fields in your data. For more information about the types of
13-
analysis you can perform, see <<ml-functions>>.
11+
Each {anomaly-job} has one or more _detectors_. A detector applies an analytical
12+
function to specific fields in your data. For more information about the types
13+
of analysis you can perform, see <<ml-functions>>.
1414

1515
A job can also contain properties that affect which types of entities or events
1616
are considered anomalous. For example, you can specify whether entities are
@@ -20,7 +20,7 @@ categories and partitions. Some of these more advanced job configurations
2020
are described in the following section: <<ml-configuring>>.
2121

2222
For a description of all the job properties, see
23-
{ref}/ml-job-resource.html[Job Resources].
23+
{ref}/ml-job-resource.html[{anomaly-job-cap} resources].
2424

2525
In {kib}, there are wizards that help you create specific types of jobs, such
2626
as _single metric_, _multi-metric_, and _population_ jobs. A single metric job

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-limitations]]
3-
== Machine learning limitations
3+
== {ml-cap} {anomaly-detect} limitations
44
[subs="attributes"]
55
++++
66
<titleabbrev>Limitations</titleabbrev>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
By default, as described in <<ml-analyzing>>, anomaly detection is unsupervised
66
and the {ml} models have no awareness of the domain of your data. As a result,
7-
{ml} jobs might identify events that are statistically significant but are
7+
{anomaly-jobs} might identify events that are statistically significant but are
88
uninteresting when you know the larger context. Machine learning custom rules
99
enable you to customize anomaly detection.
1010

@@ -22,7 +22,7 @@ for the rule, such that it applies only to certain machines. The scope is
2222
defined by using {ml} filters.
2323

2424
_Filters_ contain a list of values that you can use to include or exclude events
25-
from the {ml} analysis. You can use the same filter in multiple jobs.
25+
from the {ml} analysis. You can use the same filter in multiple {anomaly-jobs}.
2626

2727
If you are analyzing web traffic, you might create a filter that contains a list
2828
of IP addresses. For example, maybe they are IP addresses that you trust to

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

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-troubleshooting]]
3-
== Troubleshooting {ml}
3+
== Troubleshooting {ml} {anomaly-detect}
44
++++
55
<titleabbrev>Troubleshooting</titleabbrev>
66
++++
@@ -42,7 +42,7 @@ For more information, see {ref}/rolling-upgrades.html[Rolling upgrades].
4242
[[ml-mappingclash]]
4343
=== Job creation failure due to mapping clash
4444

45-
This problem occurs when you try to create a job.
45+
This problem occurs when you try to create an {anomaly-job}.
4646

4747
*Symptoms:*
4848

@@ -61,15 +61,16 @@ data types or different `fields` settings.
6161

6262
By default, {ml} results are stored in the `.ml-anomalies-shared` index in {es}.
6363
To resolve this issue, click *Advanced > Use dedicated index* when you create
64-
the job in {kib}. If you are using the create job API, specify an index name in
65-
the `results_index_name` property.
64+
the job in {kib}. If you are using the create {anomaly-job} job API, specify an
65+
index name in the `results_index_name` property.
6666

6767
[[ml-jobnames]]
6868
=== {kib} cannot display jobs with invalid characters in their name
6969

70-
This problem occurs when you create a job by using the
71-
{ref}/ml-put-job.html[Create Jobs API] then try to view that job in {kib}. In
72-
particular, the problem occurs when you use a period(.) in the job identifier.
70+
This problem occurs when you create an {anomaly-job} by using the
71+
{ref}/ml-put-job.html[Create {anomaly-jobs} API] then try to view that job in
72+
{kib}. In particular, the problem occurs when you use a period(.) in the job
73+
identifier.
7374

7475
*Symptoms:*
7576

@@ -82,10 +83,11 @@ abbreviated name, it is displayed.
8283

8384
*Resolution:*
8485

85-
Create jobs in {kib} or ensure that you create jobs with valid identifiers when
86-
you use the {ml} APIs. For more information about valid identifiers, see
87-
{ref}/ml-put-job.html[Create Jobs API] or
88-
{ref}/ml-job-resource.html[Job Resources].
86+
Create {anomaly-jobs} in {kib} or ensure that you create {anomaly-jobs} with
87+
valid identifiers when you use the APIs. For more information about valid
88+
identifiers, see
89+
{ref}/ml-put-job.html[Create {anomaly-jobs} API] or
90+
{ref}/ml-job-resource.html[{anomaly-detect-cap} job resources].
8991

9092
[[ml-upgradedf]]
9193

0 commit comments

Comments
 (0)