honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/ml/anomaly-detection/apis/get-ml-info.asciidoc

126 lines
3.2 KiB
Plaintext
Raw Normal View History

[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
[role="xpack"]
[testenv="platinum"]
[[get-ml-info]]
[DOCS] Changes level offset for anomaly detection APIs (#59920) (#59928)
2020-07-20 16:10:54 -04:00
= Get machine learning info API
[DOCS] Allow attribute substitution in titleabbrevs for Asciidoctor migration (#41574) * [DOCS] Replace attributes in titleabbrevs for Asciidoctor migration * [DOCS] Add [subs="attributes"] so attributes render in Asciidoctor * Revert "[DOCS] Replace attributes in titleabbrevs for Asciidoctor migration" This reverts commit 98f130257a7c71e9f6cddf5157af7886418338d8. * [DOCS] Fix merge conflict
2019-04-30 13:46:13 -04:00
[subs="attributes"]
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
++++
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
<titleabbrev>Get {ml} info</titleabbrev>
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
++++
Returns defaults and limits used by machine learning.
[DOCS] Adds anchors and attributes to ML APIs
2019-06-27 12:42:47 -04:00
[[get-ml-info-request]]
[DOCS] Changes level offset for anomaly detection APIs (#59920) (#59928)
2020-07-20 16:10:54 -04:00
== {api-request-title}
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
[ML] Deprecate X-Pack centric ML endpoints (#36315) This commit is part of our plan to deprecate and ultimately remove the use of _xpack in the REST APIs. Relates #35958
2018-12-07 15:34:11 -05:00
`GET _ml/info`
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
[DOCS] Updates ML APIs to use new API template (#43711)
2019-06-27 16:58:42 -04:00
[[get-ml-info-prereqs]]
[DOCS] Changes level offset for anomaly detection APIs (#59920) (#59928)
2020-07-20 16:10:54 -04:00
== {api-prereq-title}
[DOCS] Updates ML APIs to use new API template (#43711)
2019-06-27 16:58:42 -04:00
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. The
`machine_learning_admin` and `machine_learning_user` roles provide these
[DOCS] Fix security links in machine learning APIs (#60098) (#60152)
2020-07-23 19:43:10 -04:00
privileges. See <<security-privileges>>, <<built-in-roles>> and
{ml-docs-setup-privileges}.
[DOCS] Updates ML APIs to use new API template (#43711)
2019-06-27 16:58:42 -04:00
[DOCS] Adds anchors and attributes to ML APIs
2019-06-27 12:42:47 -04:00
[[get-ml-info-desc]]
[DOCS] Changes level offset for anomaly detection APIs (#59920) (#59928)
2020-07-20 16:10:54 -04:00
== {api-description-title}
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
This endpoint is designed to be used by a user interface that needs to fully
understand machine learning configurations where some options are not specified,
meaning that the defaults should be used. This endpoint may be used to find out
what those defaults are.
[DOCS] Adds anchors and attributes to ML APIs
2019-06-27 12:42:47 -04:00
[[get-ml-info-example]]
[DOCS] Changes level offset for anomaly detection APIs (#59920) (#59928)
2020-07-20 16:10:54 -04:00
== {api-examples-title}
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
The endpoint takes no arguments:
[DOCS] Change // CONSOLE comments to [source,console] (#46441) (#46451)
2019-09-06 11:31:13 -04:00
[source,console]
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
--------------------------------------------------
[ML] Deprecate X-Pack centric ML endpoints (#36315) This commit is part of our plan to deprecate and ultimately remove the use of _xpack in the REST APIs. Relates #35958
2018-12-07 15:34:11 -05:00
GET _ml/info
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
--------------------------------------------------
// TEST
This is a possible response:
[DOCS] [5 of 5] Change // TESTRESPONSE comments to [source,console-results] (#46449) (#46459)
2019-09-06 16:09:09 -04:00
[source,console-result]
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
----
{
"defaults" : {
"anomaly_detectors" : {
[ML] Add default categorization analyzer definition to ML info (#49545) The categorization job wizard in the ML UI will use this information when showing the effect of the chosen categorization analyzer on a sample of input.
2019-11-25 08:20:12 -05:00
"categorization_analyzer" : {
"tokenizer" : "ml_classic",
"filter" : [
{
"type" : "stop",
"stopwords" : [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday",
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun",
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"September",
"October",
"November",
"December",
"Jan",
"Feb",
"Mar",
"Apr",
"May",
"Jun",
"Jul",
"Aug",
"Sep",
"Oct",
"Nov",
"Dec",
"GMT",
"UTC"
]
}
]
},
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
"model_memory_limit" : "1gb",
"categorization_examples_limit" : 4,
[7.x][ML] More advanced model snapshot retention options (#56194) This PR implements the following changes to make ML model snapshot retention more flexible in advance of adding a UI for the feature in an upcoming release. - The default for `model_snapshot_retention_days` for new jobs is now 10 instead of 1 - There is a new job setting, `daily_model_snapshot_retention_after_days`, that defaults to 1 for new jobs and `model_snapshot_retention_days` for pre-7.8 jobs - For days that are older than `model_snapshot_retention_days`, all model snapshots are deleted as before - For days that are in between `daily_model_snapshot_retention_after_days` and `model_snapshot_retention_days` all but the first model snapshot for that day are deleted - The `retain` setting of model snapshots is still respected to allow selected model snapshots to be retained indefinitely Backport of #56125
2020-05-05 09:31:58 -04:00
"model_snapshot_retention_days" : 10,
"daily_model_snapshot_retention_after_days" : 1
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
},
"datafeeds" : {
"scroll_size" : 1000
}
},
ML: Adds set_upgrade_mode API endpoint (#37837) * ML: Add MlMetadata.upgrade_mode and API * Adding tests * Adding wait conditionals for the upgrade_mode call to return * Adding tests * adjusting format and tests * Adjusting wait conditions for api return and msgs * adjusting doc tests * adding upgrade mode tests to black list
2019-01-28 10:07:30 -05:00
"upgrade_mode": false,
Add native code info to ML info api (#43172) The machine learning feature of xpack has native binaries with a different commit id than the rest of code. It is currently exposed in the xpack info api. This commit adds that commit information to the ML info api, so that it may be removed from the info api.
2019-06-13 14:38:29 -04:00
"native_code" : {
"version": "7.0.0",
"build_hash": "99a07c016d5a73"
},
[ML] Add effective max model memory limit to ML info (#55581) The ML info endpoint returns the max_model_memory_limit setting if one is configured. However, it is still possible to create a job that cannot run anywhere in the current cluster because no node in the cluster has enough memory to accommodate it. This change adds an extra piece of information, limits.effective_max_model_memory_limit, to the ML info response that returns the biggest model memory limit that could be run in the current cluster assuming no other jobs were running. The idea is that the ML UI will be able to warn users who try to create jobs with higher model memory limits that their jobs will not be able to start unless they add a bigger ML node to their cluster. Backport of #55529
2020-04-22 07:28:50 -04:00
"limits" : {
"effective_max_model_memory_limit": "28961mb"
}
[ML] Add docs for ML info endpoint (#35783) This endpoint was not previously documented as it was not particularly useful to end users. However, since the HLRC will support the endpoint we need some documentation to link to. The purpose of the endpoint is to provide defaults and limits used by ML. These are needed to fully understand configurations that have missing values because the missing value means the default should be used. Relates #35777
2018-11-22 11:23:31 -05:00
}
----
relax ML Info Docs expected response (#38993) the get-ml-info API documentation tested that the response show that ML's `upgrade_mode` was false. For reasons that may be true due to other tests running in parallel or not cleaning themselves up, this may not be guaranteed. Since the actual value here is not of importance, this commit relaxes the requirement that upgrade_mode be static.
2019-02-15 19:26:41 -05:00
// TESTRESPONSE[s/"upgrade_mode": false/"upgrade_mode": $body.upgrade_mode/]
Add native code info to ML info api (#43172) The machine learning feature of xpack has native binaries with a different commit id than the rest of code. It is currently exposed in the xpack info api. This commit adds that commit information to the ML info api, so that it may be removed from the info api.
2019-06-13 14:38:29 -04:00
// TESTRESPONSE[s/"version": "7.0.0",/"version": "$body.native_code.version",/]
// TESTRESPONSE[s/"build_hash": "99a07c016d5a73"/"build_hash": "$body.native_code.build_hash"/]
[ML] Add effective max model memory limit to ML info (#55581) The ML info endpoint returns the max_model_memory_limit setting if one is configured. However, it is still possible to create a job that cannot run anywhere in the current cluster because no node in the cluster has enough memory to accommodate it. This change adds an extra piece of information, limits.effective_max_model_memory_limit, to the ML info response that returns the biggest model memory limit that could be run in the current cluster assuming no other jobs were running. The idea is that the ML UI will be able to warn users who try to create jobs with higher model memory limits that their jobs will not be able to start unless they add a bigger ML node to their cluster. Backport of #55529
2020-04-22 07:28:50 -04:00
// TESTRESPONSE[s/"effective_max_model_memory_limit": "28961mb"/"effective_max_model_memory_limit": "$body.limits.effective_max_model_memory_limit"/]