mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 15:17:30 -04:00
[ML] Update documentation regarding versioning. (#98320)
Update the ml and transform reference documentation to provide information regarding the new versioning schemes independent from the product versions. Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
This commit is contained in:
parent
693ab3dee8
commit
3682a88199
7 changed files with 73 additions and 27 deletions
|
@ -209,7 +209,12 @@ value.
|
|||
(string) Reserved for future use, currently set to `anomaly_detector`.
|
||||
|
||||
`job_version`::
|
||||
(string) The version of {es} that existed on the node when the job was created.
|
||||
(string) The {ml} configuration version number at which the the job was created.
|
||||
|
||||
NOTE: From {es} 8.10.0, a new version number is used to
|
||||
track the configuration and state changes in the {ml} plugin. This new
|
||||
version number is decoupled from the product version and will increment
|
||||
independently. The `job_version` value represents the new version number.
|
||||
|
||||
`model_snapshot_id`::
|
||||
(string)
|
||||
|
|
|
@ -18,7 +18,7 @@ Retrieves information about model snapshots.
|
|||
[[ml-get-snapshot-prereqs]]
|
||||
== {api-prereq-title}
|
||||
|
||||
Requires the `monitor_ml` cluster privilege. This privilege is included in the
|
||||
Requires the `monitor_ml` cluster privilege. This privilege is included in the
|
||||
`machine_learning_user` built-in role.
|
||||
|
||||
[[ml-get-snapshot-path-parms]]
|
||||
|
@ -42,7 +42,7 @@ specifying `*` as the snapshot ID, or by omitting the snapshot ID.
|
|||
== {api-query-parms-title}
|
||||
|
||||
`desc`::
|
||||
(Optional, Boolean) If true, the results are sorted in descending order.
|
||||
(Optional, Boolean) If true, the results are sorted in descending order.
|
||||
Defaults to `false`.
|
||||
|
||||
`end`::
|
||||
|
@ -80,7 +80,7 @@ You can also specify the query parameters in the request body; the exception are
|
|||
(Optional, integer) Skips the specified number of snapshots. Defaults to `0`.
|
||||
|
||||
`size`:::
|
||||
(Optional, integer) Specifies the maximum number of snapshots to obtain.
|
||||
(Optional, integer) Specifies the maximum number of snapshots to obtain.
|
||||
Defaults to `100`.
|
||||
====
|
||||
|
||||
|
@ -105,7 +105,13 @@ properties:
|
|||
(date) The timestamp of the latest bucket result.
|
||||
|
||||
`min_version`::
|
||||
(string) The minimum version required to be able to restore the model snapshot.
|
||||
(string) The minimum {ml} configuration version number required to be
|
||||
able to restore the model snapshot.
|
||||
|
||||
NOTE: From {es} 8.10.0, a new version number is used to
|
||||
track the configuration and state changes in the {ml} plugin. This new
|
||||
version number is decoupled from the product version and will increment
|
||||
independently. The `min_version` value represents the new version number.
|
||||
|
||||
//Begin model_size_stats
|
||||
`model_size_stats`::
|
||||
|
|
|
@ -7,6 +7,11 @@
|
|||
|
||||
Upgrades an {anomaly-detect} model snapshot to the latest major version.
|
||||
|
||||
NOTE: From {es} 8.10.0, a new version number is used to
|
||||
track the configuration and state changes in the {ml} plugin. This new
|
||||
version number is decoupled from the product version and will increment
|
||||
independently.
|
||||
|
||||
[[ml-upgrade-job-model-snapshot-request]]
|
||||
== {api-request-title}
|
||||
|
||||
|
@ -15,7 +20,7 @@ Upgrades an {anomaly-detect} model snapshot to the latest major version.
|
|||
[[ml-upgrade-job-model-snapshot-prereqs]]
|
||||
== {api-prereq-title}
|
||||
|
||||
* Requires the `manage_ml` cluster privilege. This privilege is included in the
|
||||
* Requires the `manage_ml` cluster privilege. This privilege is included in the
|
||||
`machine_learning_admin` built-in role.
|
||||
* The upgraded snapshot must have a version matching the previous major version.
|
||||
* The upgraded snapshot must NOT be the current {anomaly-job} snapshot.
|
||||
|
|
|
@ -419,6 +419,10 @@ of the most recent snapshot for this job. Valid values range from `0` to
|
|||
jobs created before version 7.8.0, the default value matches
|
||||
`model_snapshot_retention_days`. For more information, refer to
|
||||
{ml-docs}/ml-ad-run-jobs.html#ml-ad-model-snapshots[Model snapshots].
|
||||
NOTE: From {es} 8.10.0, a new version number is used to
|
||||
track the configuration and state changes in the {ml} plugin. This new
|
||||
version number is decoupled from the product version and will increment
|
||||
independently.
|
||||
end::daily-model-snapshot-retention-after-days[]
|
||||
|
||||
tag::data-description[]
|
||||
|
@ -1411,6 +1415,13 @@ ensure that high resource usage is a conscious decision. If you have jobs that
|
|||
are expected to analyze high cardinality fields, you will likely need to use a
|
||||
higher value.
|
||||
+
|
||||
--
|
||||
NOTE: From {es} 8.10.0, a new version number is used to
|
||||
track the configuration and state changes in the {ml} plugin. This new
|
||||
version number is decoupled from the product version and will increment
|
||||
independently.
|
||||
--
|
||||
+
|
||||
If you specify a number instead of a string, the units are assumed to be MiB.
|
||||
Specifying a string is recommended for clarity. If you specify a byte size unit
|
||||
of `b` or `kb` and the number does not equate to a discrete number of megabytes,
|
||||
|
@ -1856,6 +1867,11 @@ tokenizer in old versions of the product (before 6.2). `ml_classic` was
|
|||
the default categorization tokenizer in versions 6.2 to 7.13, so if you
|
||||
need categorization identical to the default for jobs created in these
|
||||
versions, specify `"tokenizer": "ml_classic"` in your `categorization_analyzer`.
|
||||
|
||||
NOTE: From {es} 8.10.0, a new version number is used to
|
||||
track the configuration and state changes in the {ml} plugin. This new
|
||||
version number is decoupled from the product version and will increment
|
||||
independently.
|
||||
end::tokenizer[]
|
||||
|
||||
tag::total-by-field-count[]
|
||||
|
|
|
@ -1429,7 +1429,12 @@ A comma delimited string of tags. A trained model can have many tags, or none.
|
|||
|
||||
`version`::
|
||||
(string)
|
||||
The {es} version number in which the trained model was created.
|
||||
The {ml} configuration version number at which the trained model was created.
|
||||
|
||||
NOTE: From {es} 8.10.0, a new version number is used to
|
||||
track the configuration and state changes in the {ml} plugin. This new
|
||||
version number is decoupled from the product version and will increment
|
||||
independently. The `version` value represents the new version number.
|
||||
|
||||
====
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ Retrieves configuration information for {transforms}.
|
|||
[[get-transform-prereqs]]
|
||||
== {api-prereq-title}
|
||||
|
||||
Requires the `monitor_transform` cluster privilege. This privilege is included
|
||||
Requires the `monitor_transform` cluster privilege. This privilege is included
|
||||
in the `transform_user` built-in role.
|
||||
|
||||
[[get-transform-desc]]
|
||||
|
@ -77,8 +77,12 @@ value in ascending order. For the full list of properties, see
|
|||
This property is informational; you cannot change its value.
|
||||
|
||||
`version`::
|
||||
(string) The version of {es} that existed on the node when the {transform} was
|
||||
created.
|
||||
(string) The {transform} configuration version number at which the trained model was created.
|
||||
|
||||
NOTE: From {es} 8.10.0, a new version number is used to
|
||||
track the configuration and state changes in the {transform} plugin. This new
|
||||
version number is decoupled from the product version and will increment
|
||||
independently. The `version` value represents the new version number.
|
||||
|
||||
[[get-transform-response-codes]]
|
||||
== {api-response-codes-title}
|
||||
|
|
|
@ -26,30 +26,35 @@ Requires the following privileges:
|
|||
[[upgrade-transforms-desc]]
|
||||
== {api-description-title}
|
||||
|
||||
{transforms-cap} are compatible across minor versions and between supported
|
||||
major versions. However, over time, the format of {transform} configuration
|
||||
information may change. This API identifies {transforms} which have a legacy
|
||||
configuration format and upgrades them to the latest version; including clean up
|
||||
of the internal data structures that store {transform} state and checkpoints.
|
||||
{transforms-cap} are compatible across minor versions and between supported
|
||||
major versions. However, over time, the format of {transform} configuration
|
||||
information may change. This API identifies {transforms} which have a legacy
|
||||
configuration format and upgrades them to the latest version; including clean up
|
||||
of the internal data structures that store {transform} state and checkpoints.
|
||||
{transform-cap} upgrade does not affect the source and destination indices.
|
||||
|
||||
If a {transform} upgrade step fails, the upgrade stops, and an error is returned
|
||||
about the underlying issue. Resolve the issue then re-run the process again. A
|
||||
NOTE: From {es} 8.10.0, a new version number is used to
|
||||
track the configuration and state changes in the {transform} plugin. This new
|
||||
version number is decoupled from the product version and will increment
|
||||
independently.
|
||||
|
||||
If a {transform} upgrade step fails, the upgrade stops, and an error is returned
|
||||
about the underlying issue. Resolve the issue then re-run the process again. A
|
||||
summary is returned when the upgrade is finished.
|
||||
|
||||
To ensure {ctransforms} remain running during a major version upgrade of the
|
||||
cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade
|
||||
{transforms} before upgrading the cluster. You may want to perform a recent
|
||||
To ensure {ctransforms} remain running during a major version upgrade of the
|
||||
cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade
|
||||
{transforms} before upgrading the cluster. You may want to perform a recent
|
||||
cluster backup prior to the upgrade.
|
||||
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
* When {es} {security-features} are enabled, your {transform} remembers the
|
||||
roles of the user who created or updated it last. In contrast to
|
||||
<<update-transform,update transform>>, a {transform} upgrade does not change the
|
||||
stored roles, therefore the role used to read source data and write to the
|
||||
* When {es} {security-features} are enabled, your {transform} remembers the
|
||||
roles of the user who created or updated it last. In contrast to
|
||||
<<update-transform,update transform>>, a {transform} upgrade does not change the
|
||||
stored roles, therefore the role used to read source data and write to the
|
||||
destination index remains unchanged.
|
||||
|
||||
====
|
||||
|
@ -59,7 +64,7 @@ destination index remains unchanged.
|
|||
== {api-query-parms-title}
|
||||
|
||||
`dry_run`::
|
||||
(Optional, Boolean) When `true`, only checks for updates but does not execute
|
||||
(Optional, Boolean) When `true`, only checks for updates but does not execute
|
||||
them. Defaults to `false`.
|
||||
|
||||
`timeout`::
|
||||
|
@ -77,7 +82,7 @@ expires, the request fails and returns an error. Defaults to `30s`.
|
|||
`no_action`::
|
||||
(integer) The number of {transforms} that don't require upgrading.
|
||||
|
||||
`updated`::
|
||||
`updated`::
|
||||
(integer) The number of {transforms} that have been upgraded.
|
||||
|
||||
|
||||
|
@ -85,7 +90,7 @@ expires, the request fails and returns an error. Defaults to `30s`.
|
|||
[[upgrade-transforms-example]]
|
||||
== {api-examples-title}
|
||||
|
||||
To upgrade the legacy {transforms} to the latest configuration format, perform
|
||||
To upgrade the legacy {transforms} to the latest configuration format, perform
|
||||
the following API call:
|
||||
|
||||
[source,console]
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue