honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Fixes, sorts ML tagged regions (#52283)

This commit is contained in:
Lisa Cawley 2020-02-12 13:43:21 -08:00 committed by lcawl
parent d9fd6fc90c
commit 40b58e612d
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/reference/ml/ml-shared.asciidoc
View File

@ -642,23 +642,9 @@ to `false`. When `true`, only a single model must match the ID patterns
provided, otherwise a bad request is returned. provided, otherwise a bad request is returned.
end::include-model-definition[] end::include-model-definition[]
tag::tags[]
A comma delimited string of tags. A {infer} model can have many tags, or none.
When supplied, only {infer} models that contain all the supplied tags are
returned.
end::tags[]
tag::indices[] tag::indices[]
An array of index names. Wildcards are supported. For example: An array of index names. Wildcards are supported. For example:
`["it_ops_metrics", "server*"]`. `["it_ops_metrics", "server*"]`.
tag::num-top-feature-importance-values[]
Advanced configuration option. If set, feature importance for the top
most important features will be computed. Importance is calculated
using the SHAP (SHapley Additive exPlanations) method as described in
https://papers.nips.cc/paper/7062-a-unified-approach-to-interpreting-model-predictions.pdf[Lundberg, S. M., & Lee, S.-I. A Unified Approach to Interpreting Model Predictions. In NeurIPS 2017.].
end::num-top-feature-importance-values[]
+ +
-- --
NOTE: If any indices are in remote clusters then `cluster.remote.connect` must NOTE: If any indices are in remote clusters then `cluster.remote.connect` must
@ -918,6 +904,13 @@ total number of categories (in the {version} version of the {stack}, it's two)
to predict then we will report all category probabilities. Defaults to 2. to predict then we will report all category probabilities. Defaults to 2.
end::num-top-classes[] end::num-top-classes[]
tag::num-top-feature-importance-values[]
Advanced configuration option. If set, feature importance for the top
most important features will be computed. Importance is calculated
using the SHAP (SHapley Additive exPlanations) method as described in
https://papers.nips.cc/paper/7062-a-unified-approach-to-interpreting-model-predictions.pdf[Lundberg, S. M., & Lee, S.-I. A Unified Approach to Interpreting Model Predictions. In NeurIPS 2017.].
end::num-top-feature-importance-values[]
tag::over-field-name[] tag::over-field-name[]
The field used to split the data. In particular, this property is used for The field used to split the data. In particular, this property is used for
analyzing the splits with respect to the history of all splits. It is used for analyzing the splits with respect to the history of all splits. It is used for
@ -1062,6 +1055,12 @@ function.
-- --
end::summary-count-field-name[] end::summary-count-field-name[]
tag::tags[]
A comma delimited string of tags. A {infer} model can have many tags, or none.
When supplied, only {infer} models that contain all the supplied tags are
returned.
end::tags[]
tag::time-format[] tag::time-format[]
The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The
default value is `epoch`, which refers to UNIX or Epoch time (the number of default value is `epoch`, which refers to UNIX or Epoch time (the number of