Skip to content

Commit 5f3dfec

Browse files
committed
[DOCS] Cleans up xpackml attributes
1 parent a1838da commit 5f3dfec

13 files changed

+20
-21
lines changed

docs/reference/ml/aggregations.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ and to configure your jobs to analyze aggregated data.
88

99
One of the benefits of aggregating data this way is that {es} automatically
1010
distributes these calculations across your cluster. You can then feed this
11-
aggregated data into {xpackml} instead of raw results, which
11+
aggregated data into the {ml-features} instead of raw results, which
1212
reduces the volume of data that must be considered while detecting anomalies.
1313

1414
There are some limitations to using aggregations in {dfeeds}, however.

docs/reference/ml/apis/resultsresource.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ probability of this occurrence.
269269

270270
There can be many anomaly records depending on the characteristics and size of
271271
the input data. In practice, there are often too many to be able to manually
272-
process them. The {xpackml} features therefore perform a sophisticated
272+
process them. The {ml-features} therefore perform a sophisticated
273273
aggregation of the anomaly records into buckets.
274274

275275
The number of record results depends on the number of anomalies found in each

docs/reference/ml/configuring.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
[[ml-configuring]]
33
== Configuring machine learning
44

5-
If you want to use {xpackml} features, there must be at least one {ml} node in
5+
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,
77
all nodes are {ml} nodes. For more information about these settings, see
88
{ref}/modules-node.html#modules-node-xpack[{ml} nodes].
99

10-
To use the {xpackml} features to analyze your data, you must create a job and
10+
To use the {ml-features} to analyze your data, you must create a job and
1111
send your data to that job.
1212

1313
* If your data is stored in {es}:

docs/reference/ml/functions.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[[ml-functions]]
33
== Function reference
44

5-
The {xpackml} features include analysis functions that provide a wide variety of
5+
The {ml-features} include analysis functions that provide a wide variety of
66
flexible ways to analyze data for anomalies.
77

88
When you create jobs, you specify one or more detectors, which define the type of

docs/reference/ml/functions/count.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ in one field is unusual, as opposed to the total count.
1414
Use high-sided functions if you want to monitor unusually high event rates.
1515
Use low-sided functions if you want to look at drops in event rate.
1616

17-
The {xpackml} features include the following count functions:
17+
The {ml-features} include the following count functions:
1818

1919
* xref:ml-count[`count`, `high_count`, `low_count`]
2020
* xref:ml-nonzero-count[`non_zero_count`, `high_non_zero_count`, `low_non_zero_count`]

docs/reference/ml/functions/geo.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The geographic functions detect anomalies in the geographic location of the
66
input data.
77

8-
The {xpackml} features include the following geographic function: `lat_long`.
8+
The {ml-features} include the following geographic function: `lat_long`.
99

1010
NOTE: You cannot create forecasts for jobs that contain geographic functions.
1111
You also cannot add rules with conditions to detectors that use geographic
@@ -72,7 +72,7 @@ For example, JSON data might contain the following transaction coordinates:
7272

7373
In {es}, location data is likely to be stored in `geo_point` fields. For more
7474
information, see {ref}/geo-point.html[Geo-point datatype]. This data type is not
75-
supported natively in {xpackml} features. You can, however, use Painless scripts
75+
supported natively in {ml-features}. You can, however, use Painless scripts
7676
in `script_fields` in your {dfeed} to transform the data into an appropriate
7777
format. For example, the following Painless script transforms
7878
`"coords": {"lat" : 41.44, "lon":90.5}` into `"lat-lon": "41.44,90.5"`:

docs/reference/ml/functions/info.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ that is contained in strings within a bucket. These functions can be used as
66
a more sophisticated method to identify incidences of data exfiltration or
77
C2C activity, when analyzing the size in bytes of the data might not be sufficient.
88

9-
The {xpackml} features include the following information content functions:
9+
The {ml-features} include the following information content functions:
1010

1111
* `info_content`, `high_info_content`, `low_info_content`
1212

docs/reference/ml/functions/metric.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The metric functions include functions such as mean, min and max. These values
66
are calculated for each bucket. Field values that cannot be converted to
77
double precision floating point numbers are ignored.
88

9-
The {xpackml} features include the following metric functions:
9+
The {ml-features} include the following metric functions:
1010

1111
* <<ml-metric-min,`min`>>
1212
* <<ml-metric-max,`max`>>

docs/reference/ml/functions/rare.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ with shorter bucket spans typically being measured in minutes, not hours.
2727
for typical data.
2828
====
2929

30-
The {xpackml} features include the following rare functions:
30+
The {ml-features} include the following rare functions:
3131

3232
* <<ml-rare,`rare`>>
3333
* <<ml-freq-rare,`freq_rare`>>
@@ -85,7 +85,7 @@ different rare status codes compared to the population is regarded as highly
8585
anomalous. This analysis is based on the number of different status code values,
8686
not the count of occurrences.
8787

88-
NOTE: To define a status code as rare the {xpackml} features look at the number
88+
NOTE: To define a status code as rare the {ml-features} look at the number
8989
of distinct status codes that occur, not the number of times the status code
9090
occurs. If a single client IP experiences a single unique status code, this
9191
is rare, even if it occurs for that client IP in every bucket.

docs/reference/ml/functions/sum.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If want to look at drops in totals, use low-sided functions.
1111
If your data is sparse, use `non_null_sum` functions. Buckets without values are
1212
ignored; buckets with a zero value are analyzed.
1313

14-
The {xpackml} features include the following sum functions:
14+
The {ml-features} include the following sum functions:
1515

1616
* xref:ml-sum[`sum`, `high_sum`, `low_sum`]
1717
* xref:ml-nonnull-sum[`non_null_sum`, `high_non_null_sum`, `low_non_null_sum`]

docs/reference/ml/functions/time.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The time functions detect events that happen at unusual times, either of the day
66
or of the week. These functions can be used to find unusual patterns of behavior,
77
typically associated with suspicious user activity.
88

9-
The {xpackml} features include the following time functions:
9+
The {ml-features} include the following time functions:
1010

1111
* <<ml-time-of-day,`time_of_day`>>
1212
* <<ml-time-of-week,`time_of_week`>>

docs/reference/ml/transforms.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,7 @@ GET _xpack/ml/datafeeds/datafeed-test4/_preview
573573
// TEST[skip:needs-licence]
574574

575575
In {es}, location data can be stored in `geo_point` fields but this data type is
576-
not supported natively in {xpackml} analytics. This example of a script field
576+
not supported natively in {ml} analytics. This example of a script field
577577
transforms the data into an appropriate format. For more information,
578578
see <<ml-geo-functions>>.
579579

docs/reference/modules/ml-node.asciidoc

+5-6
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,9 @@ If {xpack} is installed, there is an additional node type:
99
<<ml-node,Machine learning node>>::
1010

1111
A node that has `xpack.ml.enabled` and `node.ml` set to `true`, which is the
12-
default behavior when {xpack} is installed. If you want to use {xpackml}
13-
features, there must be at least one {ml} node in your cluster. For more
14-
information about {xpackml} features,
15-
see {xpack-ref}/xpack-ml.html[Machine Learning in the Elastic Stack].
12+
default behavior when {xpack} is installed. If you want to use {ml-features}, there must be at least one {ml} node in your cluster. For more
13+
information about {ml-features},
14+
see {stack-ov}/xpack-ml.html[Machine learning in the {stack}].
1615

1716
IMPORTANT: Do not set use the `node.ml` setting unless {xpack} is installed.
1817
Otherwise, the node fails to start.
@@ -88,11 +87,11 @@ node.ml: false <5>
8887
[[ml-node]]
8988
=== [xpack]#Machine learning node#
9089

91-
The {xpackml} features provide {ml} nodes, which run jobs and handle {ml} API
90+
The {ml-features} provide {ml} nodes, which run jobs and handle {ml} API
9291
requests. If `xpack.ml.enabled` is set to true and `node.ml` is set to `false`,
9392
the node can service API requests but it cannot run jobs.
9493

95-
If you want to use {xpackml} features in your cluster, you must enable {ml}
94+
If you want to use {ml-features} in your cluster, you must enable {ml}
9695
(set `xpack.ml.enabled` to `true`) on all master-eligible nodes. Do not use
9796
these settings if you do not have {xpack} installed.
9897

0 commit comments

Comments
 (0)