From d68c75685810cc5a482ab104f027a35c63c0601b Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Fri, 3 Dec 2021 10:42:35 -0800 Subject: [PATCH] [7.16][DOCS] Move trained model APIs out of dataframe analytics (#81315) (#81324) --- .../ml/df-analytics/apis/index.asciidoc | 10 ++------- .../apis/ml-df-analytics-apis.asciidoc | 22 +------------------ .../delete-trained-models-aliases.asciidoc | 0 .../apis/delete-trained-models.asciidoc | 0 .../apis/get-trained-models-stats.asciidoc | 0 .../apis/get-trained-models.asciidoc | 0 .../ml/trained-models/apis/index.asciidoc | 11 ++++++++++ .../apis/ml-trained-models-apis.asciidoc | 18 +++++++++++++++ .../apis/put-trained-models-aliases.asciidoc | 0 .../apis/put-trained-models.asciidoc | 0 docs/reference/rest-api/index.asciidoc | 1 + 11 files changed, 33 insertions(+), 29 deletions(-) rename docs/reference/ml/{df-analytics => trained-models}/apis/delete-trained-models-aliases.asciidoc (100%) rename docs/reference/ml/{df-analytics => trained-models}/apis/delete-trained-models.asciidoc (100%) rename docs/reference/ml/{df-analytics => trained-models}/apis/get-trained-models-stats.asciidoc (100%) rename docs/reference/ml/{df-analytics => trained-models}/apis/get-trained-models.asciidoc (100%) create mode 100644 docs/reference/ml/trained-models/apis/index.asciidoc create mode 100644 docs/reference/ml/trained-models/apis/ml-trained-models-apis.asciidoc rename docs/reference/ml/{df-analytics => trained-models}/apis/put-trained-models-aliases.asciidoc (100%) rename docs/reference/ml/{df-analytics => trained-models}/apis/put-trained-models.asciidoc (100%) diff --git a/docs/reference/ml/df-analytics/apis/index.asciidoc b/docs/reference/ml/df-analytics/apis/index.asciidoc index 8c0f8713c90ab..b3fb03eccd4d1 100644 --- a/docs/reference/ml/df-analytics/apis/index.asciidoc +++ b/docs/reference/ml/df-analytics/apis/index.asciidoc @@ -1,14 +1,8 @@ include::ml-df-analytics-apis.asciidoc[leveloffset=+1] //CREATE include::put-dfanalytics.asciidoc[leveloffset=+2] -include::put-trained-models-aliases.asciidoc[leveloffset=+2] -include::put-trained-models.asciidoc[leveloffset=+2] -//UPDATE -include::update-dfanalytics.asciidoc[leveloffset=+2] //DELETE include::delete-dfanalytics.asciidoc[leveloffset=+2] -include::delete-trained-models.asciidoc[leveloffset=+2] -include::delete-trained-models-aliases.asciidoc[leveloffset=+2] //EVALUATE include::evaluate-dfanalytics.asciidoc[leveloffset=+2] //ESTIMATE_MEMORY_USAGE @@ -16,10 +10,10 @@ include::explain-dfanalytics.asciidoc[leveloffset=+2] //GET include::get-dfanalytics.asciidoc[leveloffset=+2] include::get-dfanalytics-stats.asciidoc[leveloffset=+2] -include::get-trained-models.asciidoc[leveloffset=+2] -include::get-trained-models-stats.asciidoc[leveloffset=+2] //PREVIEW include::preview-dfanalytics.asciidoc[leveloffset=+2] //SET/START/STOP include::start-dfanalytics.asciidoc[leveloffset=+2] include::stop-dfanalytics.asciidoc[leveloffset=+2] +//UPDATE +include::update-dfanalytics.asciidoc[leveloffset=+2] diff --git a/docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc b/docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc index 65bc60c51e236..24be8fd1d45ab 100644 --- a/docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc +++ b/docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc @@ -12,24 +12,4 @@ You can use the following APIs to perform {ml} {dfanalytics} activities. * <> * <> * <> -* <> -* <> - - -You can use the following APIs to perform {infer} operations. - -* <> -* <> -* <> -* <> -* <> -* <> - -You can deploy a trained model to make predictions in an ingest pipeline or in -an aggregation. Refer to the following documentation to learn more. - -* <> -* <> - - -See also <>. +* <> diff --git a/docs/reference/ml/df-analytics/apis/delete-trained-models-aliases.asciidoc b/docs/reference/ml/trained-models/apis/delete-trained-models-aliases.asciidoc similarity index 100% rename from docs/reference/ml/df-analytics/apis/delete-trained-models-aliases.asciidoc rename to docs/reference/ml/trained-models/apis/delete-trained-models-aliases.asciidoc diff --git a/docs/reference/ml/df-analytics/apis/delete-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc similarity index 100% rename from docs/reference/ml/df-analytics/apis/delete-trained-models.asciidoc rename to docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc diff --git a/docs/reference/ml/df-analytics/apis/get-trained-models-stats.asciidoc b/docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc similarity index 100% rename from docs/reference/ml/df-analytics/apis/get-trained-models-stats.asciidoc rename to docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc diff --git a/docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc similarity index 100% rename from docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc rename to docs/reference/ml/trained-models/apis/get-trained-models.asciidoc diff --git a/docs/reference/ml/trained-models/apis/index.asciidoc b/docs/reference/ml/trained-models/apis/index.asciidoc new file mode 100644 index 0000000000000..63d162184ffc4 --- /dev/null +++ b/docs/reference/ml/trained-models/apis/index.asciidoc @@ -0,0 +1,11 @@ +include::ml-trained-models-apis.asciidoc[leveloffset=+1] +//CREATE +include::put-trained-models-aliases.asciidoc[leveloffset=+2] +include::put-trained-models.asciidoc[leveloffset=+2] +//DELETE +include::delete-trained-models-aliases.asciidoc[leveloffset=+2] +include::delete-trained-models.asciidoc[leveloffset=+2] +//GET +include::get-trained-models.asciidoc[leveloffset=+2] +include::get-trained-models-stats.asciidoc[leveloffset=+2] + diff --git a/docs/reference/ml/trained-models/apis/ml-trained-models-apis.asciidoc b/docs/reference/ml/trained-models/apis/ml-trained-models-apis.asciidoc new file mode 100644 index 0000000000000..b586ec9d4d0be --- /dev/null +++ b/docs/reference/ml/trained-models/apis/ml-trained-models-apis.asciidoc @@ -0,0 +1,18 @@ +[role="xpack"] +[[ml-df-trained-models-apis]] += {ml-cap} trained model APIs + +You can use the following APIs to perform model management operations: + +* <> +* <> +* <> +* <> +* <> +* <> + +You can deploy a trained model to make predictions in an ingest pipeline or in +an aggregation. Refer to the following documentation to learn more: + +* <> +* <> diff --git a/docs/reference/ml/df-analytics/apis/put-trained-models-aliases.asciidoc b/docs/reference/ml/trained-models/apis/put-trained-models-aliases.asciidoc similarity index 100% rename from docs/reference/ml/df-analytics/apis/put-trained-models-aliases.asciidoc rename to docs/reference/ml/trained-models/apis/put-trained-models-aliases.asciidoc diff --git a/docs/reference/ml/df-analytics/apis/put-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/put-trained-models.asciidoc similarity index 100% rename from docs/reference/ml/df-analytics/apis/put-trained-models.asciidoc rename to docs/reference/ml/trained-models/apis/put-trained-models.asciidoc diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index abe22c3101758..77cf690d3e004 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -69,6 +69,7 @@ include::{es-repo-dir}/licensing/index.asciidoc[] include::{xes-repo-dir}/rest-api/logstash/index.asciidoc[] include::{es-repo-dir}/ml/anomaly-detection/apis/index.asciidoc[] include::{es-repo-dir}/ml/df-analytics/apis/index.asciidoc[] +include::{es-repo-dir}/ml/trained-models/apis/index.asciidoc[] include::{es-repo-dir}/migration/migration.asciidoc[] include::{es-repo-dir}/shutdown/apis/shutdown-api.asciidoc[] include::{es-repo-dir}/indices/apis/reload-analyzers.asciidoc[]