From b07b75ce149bb315857bbe4a78dbd87f14c7619d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 7 Sep 2020 12:14:13 +0200 Subject: [PATCH] [DOCS] Removes inference from the names of trained model APIs. (#62036) (#62041) # Conflicts: # docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc --- .../delete-inference-trained-model.asciidoc | 8 +++--- ...get-inference-trained-model-stats.asciidoc | 26 +++++++++---------- .../apis/get-inference-trained-model.asciidoc | 17 ++++++------ .../df-analytics/apis/put-inference.asciidoc | 14 +++++----- 4 files changed, 33 insertions(+), 32 deletions(-) diff --git a/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc b/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc index 7f082652a99..469d45a3656 100644 --- a/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc @@ -1,10 +1,10 @@ [role="xpack"] [testenv="basic"] [[delete-inference]] -= Delete {infer} trained model API += Delete trained model API [subs="attributes"] ++++ -Delete {infer} trained model +Delete trained model ++++ Deletes an existing trained {infer} model that is currently not referenced by an @@ -41,8 +41,8 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] == {api-response-codes-title} `409`:: - The code indicates that the trained {infer} model is referenced by an ingest - pipeline and cannot be deleted. + The code indicates that the trained model is referenced by an ingest pipeline + and cannot be deleted. [[ml-delete-inference-example]] diff --git a/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc index 37bc73cce20..1df9590b6fe 100644 --- a/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc @@ -1,13 +1,13 @@ [role="xpack"] [testenv="basic"] [[get-inference-stats]] -= Get {infer} trained model statistics API += Get trained model statistics API [subs="attributes"] ++++ -Get {infer} trained model stats +Get trained model stats ++++ -Retrieves usage information for trained {infer} models. +Retrieves usage information for trained models. experimental[] @@ -71,14 +71,14 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size] `count`:: (integer) -The total number of trained model statistics that matched the requested ID patterns. -Could be higher than the number of items in the `trained_model_stats` array as the -size of the array is restricted by the supplied `size` parameter. +The total number of trained model statistics that matched the requested ID +patterns. Could be higher than the number of items in the `trained_model_stats` +array as the size of the array is restricted by the supplied `size` parameter. `trained_model_stats`:: (array) -An array of trained model statistics, which are sorted by the `model_id` value in -ascending order. +An array of trained model statistics, which are sorted by the `model_id` value +in ascending order. + .Properties of trained model stats [%collapsible%open] @@ -111,11 +111,11 @@ This is across all inference contexts, including all pipelines. `cache_miss_count`::: (integer) -The number of times the model was loaded for inference and was not retrieved from the -cache. If this number is close to the `inference_count`, then the cache -is not being appropriately used. This can be remedied by increasing the cache's size -or its time-to-live (TTL). See <> for the -appropriate settings. +The number of times the model was loaded for inference and was not retrieved +from the cache. If this number is close to the `inference_count`, then the cache +is not being appropriately used. This can be solved by increasing the cache size +or its time-to-live (TTL). See <> for the appropriate +settings. `failure_count`::: (integer) diff --git a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc index c9fe7786853..11b43f73e09 100644 --- a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc @@ -1,13 +1,13 @@ [role="xpack"] [testenv="basic"] [[get-inference]] -= Get {infer} trained model API += Get trained model API [subs="attributes"] ++++ -Get {infer} trained model +Get trained model ++++ -Retrieves configuration information for a trained {infer} model. +Retrieves configuration information for a trained model. experimental[] @@ -33,7 +33,8 @@ Required privileges which should be added to a custom role: * cluster: `monitor_ml` -For more information, see <> and {ml-docs-setup-privileges}. +For more information, see <> and +{ml-docs-setup-privileges}. [[ml-get-inference-desc]] @@ -69,9 +70,9 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from] `include_model_definition`:: (Optional, boolean) -Specifies if the model definition should be returned in the response. Defaults -to `false`. When `true`, only a single model must match the ID patterns -provided, otherwise a bad request is returned. +Specifies whether the model definition is returned in the response. Defaults to +`false`. When `true`, only a single model must match the ID patterns provided. +Otherwise, a bad request is returned. `size`:: (Optional, integer) @@ -140,7 +141,7 @@ Idetifier for the trained model. `tags`::: (string) -A comma delimited string of tags. A {infer} model can have many tags, or none. +A comma delimited string of tags. A trained model can have many tags, or none. `version`::: (string) diff --git a/docs/reference/ml/df-analytics/apis/put-inference.asciidoc b/docs/reference/ml/df-analytics/apis/put-inference.asciidoc index 4e71a3611c2..7f39dfd8b1c 100644 --- a/docs/reference/ml/df-analytics/apis/put-inference.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-inference.asciidoc @@ -1,13 +1,13 @@ [role="xpack"] [testenv="basic"] [[put-inference]] -= Create {infer} trained model API += Create trained model API [subs="attributes"] ++++ -Create {infer} trained model +Create trained model ++++ -Creates an {infer} trained model. +Creates an trained model. WARNING: Models created in version 7.8.0 are not backwards compatible with older node versions. If in a mixed cluster environment, @@ -38,8 +38,8 @@ For more information, see <> and {ml-docs-setup-privileges}. [[ml-put-inference-desc]] == {api-description-title} -The create {infer} trained model API enables you to supply a trained model that -is not created by {dfanalytics}. +The create trained model API enables you to supply a trained model that is not +created by {dfanalytics}. [[ml-put-inference-path-params]] @@ -61,7 +61,7 @@ If `compressed_definition` is specified, then `definition` cannot be specified. //Begin definition `definition`:: (Required, object) -The {infer} definition for the model. If `definition` is specified, then +The {infer} definition for the model. If `definition` is specified, then `compressed_definition` cannot be specified. + .Properties of `definition` @@ -172,7 +172,7 @@ The definition for a binary decision tree. [%collapsible%open] ====== `classification_labels`::: -(Optional, string) An array of classification labels (used for +(Optional, string) An array of classification labels (used for `classification`). `feature_names`:::