Browse Source

[DOCS] Move trained model APIs out of dataframe analytics (#81315)

Lisa Cawley 3 years ago
parent
commit
429bdd9afc

+ 2 - 14
docs/reference/ml/df-analytics/apis/index.asciidoc

@@ -1,16 +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]
-include::put-trained-model-definition-part.asciidoc[leveloffset=+2]
-include::put-trained-model-vocabulary.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
@@ -18,14 +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]
-//INFER
-include::infer-trained-model-deployment.asciidoc[leveloffset=+2]
 //PREVIEW
 include::preview-dfanalytics.asciidoc[leveloffset=+2]
 //SET/START/STOP
 include::start-dfanalytics.asciidoc[leveloffset=+2]
-include::start-trained-model-deployment.asciidoc[leveloffset=+2]
 include::stop-dfanalytics.asciidoc[leveloffset=+2]
-include::stop-trained-model-deployment.asciidoc[leveloffset=+2]
+//UPDATE
+include::update-dfanalytics.asciidoc[leveloffset=+2]

+ 0 - 23
docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc

@@ -14,26 +14,3 @@ You can use the following APIs to perform {ml} {dfanalytics} activities:
 * <<start-dfanalytics,Start {dfanalytics-jobs}>>
 * <<stop-dfanalytics,Stop {dfanalytics-jobs}>>
 * <<update-dfanalytics,Update {dfanalytics-jobs}>>
-
-You can use the following APIs to perform {infer} operations:
-
-* <<put-trained-models>>
-* <<put-trained-model-definition-part>>
-* <<put-trained-model-vocabulary>>
-* <<put-trained-models-aliases>>
-* <<delete-trained-models>>
-* <<delete-trained-models-aliases>>
-* <<get-trained-models>>
-* <<get-trained-models-stats>>
-
-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:
-
-* <<search-aggregations-pipeline-inference-bucket-aggregation,{infer-cap} bucket aggregation>>
-* <<inference-processor,{infer-cap} processor>>
-* <<infer-trained-model-deployment>>
-* <<start-trained-model-deployment>>
-* <<stop-trained-model-deployment>>
-
-
-See also <<ml-apis>>.

+ 0 - 0
docs/reference/ml/df-analytics/apis/delete-trained-models-aliases.asciidoc → docs/reference/ml/trained-models/apis/delete-trained-models-aliases.asciidoc


+ 0 - 0
docs/reference/ml/df-analytics/apis/delete-trained-models.asciidoc → docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc


+ 0 - 0
docs/reference/ml/df-analytics/apis/get-trained-model-deployment-stats.asciidoc → docs/reference/ml/trained-models/apis/get-trained-model-deployment-stats.asciidoc


+ 0 - 0
docs/reference/ml/df-analytics/apis/get-trained-models-stats.asciidoc → docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc


+ 0 - 0
docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc → docs/reference/ml/trained-models/apis/get-trained-models.asciidoc


+ 17 - 0
docs/reference/ml/trained-models/apis/index.asciidoc

@@ -0,0 +1,17 @@
+include::ml-trained-models-apis.asciidoc[leveloffset=+1]
+//CREATE
+include::put-trained-models-aliases.asciidoc[leveloffset=+2]
+include::put-trained-model-definition-part.asciidoc[leveloffset=+2]
+include::put-trained-models.asciidoc[leveloffset=+2]
+include::put-trained-model-vocabulary.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]
+//INFER
+include::infer-trained-model-deployment.asciidoc[leveloffset=+2]
+//START/STOP
+include::start-trained-model-deployment.asciidoc[leveloffset=+2]
+include::stop-trained-model-deployment.asciidoc[leveloffset=+2]

+ 0 - 0
docs/reference/ml/df-analytics/apis/infer-trained-model-deployment.asciidoc → docs/reference/ml/trained-models/apis/infer-trained-model-deployment.asciidoc


+ 23 - 0
docs/reference/ml/trained-models/apis/ml-trained-models-apis.asciidoc

@@ -0,0 +1,23 @@
+[role="xpack"]
+[[ml-df-trained-models-apis]]
+= {ml-cap} trained model APIs
+
+You can use the following APIs to perform model management operations:
+
+* <<put-trained-models>>
+* <<put-trained-model-definition-part>>
+* <<put-trained-model-vocabulary>>
+* <<put-trained-models-aliases>>
+* <<delete-trained-models>>
+* <<delete-trained-models-aliases>>
+* <<get-trained-models>>
+* <<get-trained-models-stats>>
+* <<infer-trained-model-deployment>>
+* <<start-trained-model-deployment>>
+* <<stop-trained-model-deployment>>
+
+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:
+
+* <<search-aggregations-pipeline-inference-bucket-aggregation,{infer-cap} bucket aggregation>>
+* <<inference-processor,{infer-cap} processor>>

+ 0 - 0
docs/reference/ml/df-analytics/apis/put-trained-model-definition-part.asciidoc → docs/reference/ml/trained-models/apis/put-trained-model-definition-part.asciidoc


+ 0 - 0
docs/reference/ml/df-analytics/apis/put-trained-model-vocabulary.asciidoc → docs/reference/ml/trained-models/apis/put-trained-model-vocabulary.asciidoc


+ 0 - 0
docs/reference/ml/df-analytics/apis/put-trained-models-aliases.asciidoc → docs/reference/ml/trained-models/apis/put-trained-models-aliases.asciidoc


+ 0 - 0
docs/reference/ml/df-analytics/apis/put-trained-models.asciidoc → docs/reference/ml/trained-models/apis/put-trained-models.asciidoc


+ 0 - 0
docs/reference/ml/df-analytics/apis/start-trained-model-deployment.asciidoc → docs/reference/ml/trained-models/apis/start-trained-model-deployment.asciidoc


+ 0 - 0
docs/reference/ml/df-analytics/apis/stop-trained-model-deployment.asciidoc → docs/reference/ml/trained-models/apis/stop-trained-model-deployment.asciidoc


+ 1 - 0
docs/reference/rest-api/index.asciidoc

@@ -71,6 +71,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[]