[ML] [DOCS] adding missing fields to the get trained models API docs (#67590) (#67600)

Adds missing fields description, inference_config, and input to the GET trained models API documentation
This commit is contained in:
Benjamin Trent 2021-01-15 13:48:34 -05:00 committed by GitHub
parent 310cd1bfeb
commit 69752d4ead
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 70 additions and 0 deletions

View File

@ -125,6 +125,10 @@ The analytics job would then supply a default field map entry for
+
Any field map described in the inference configuration takes precedence.
`description`:::
(string)
The free-text description of the trained model.
`estimated_heap_memory_usage_bytes`:::
(integer)
The estimated heap usage in bytes to keep the trained model in memory.
@ -133,6 +137,71 @@ The estimated heap usage in bytes to keep the trained model in memory.
(integer)
The estimated number of operations to use the trained model.
`inference_config`:::
(object)
The default configuration for inference. This can be either a `regression`
or `classification` configuration. It must match the underlying
`definition.trained_model`'s `target_type`.
+
.Properties of `inference_config`
[%collapsible%open]
=====
`classification`::::
(object)
Classification configuration for inference.
+
.Properties of classification inference
[%collapsible%open]
======
`num_top_classes`:::
(integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes]
`num_top_feature_importance_values`:::
(integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values]
`prediction_field_type`:::
(string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type]
`results_field`:::
(string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field]
`top_classes_results_field`:::
(string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field]
======
`regression`::::
(object)
Regression configuration for inference.
+
.Properties of regression inference
[%collapsible%open]
======
`num_top_feature_importance_values`:::
(integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values]
`results_field`:::
(string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field]
======
=====
`input`:::
(object)
The input field names for the model definition.+
+
.Properties of `input`
[%collapsible%open]
=====
`field_names`::::
(string)
An array of input field names for the model.
=====
`license_level`:::
(string)
The license level of the trained model.
@ -237,6 +306,7 @@ 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.
====
[[ml-get-trained-models-response-codes]]