Skip to content

Commit a417a70

Browse files
authored
[DOCS] Improves documentation about deploying DFA trained models (#2524)
1 parent cff5346 commit a417a70

7 files changed

+66
-14
lines changed
Loading
Loading
Loading

docs/en/stack/ml/df-analytics/ml-dfa-classification.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,8 @@ The model that you created is stored as {es} documents in internal indices. In
258258
other words, the characteristics of your trained model are saved and ready to be
259259
deployed and used as functions.
260260

261+
include::ml-dfa-shared.asciidoc[tag=dfa-deploy-model]
262+
261263

262264
[discrete]
263265
[[ml-inference-class]]

docs/en/stack/ml/df-analytics/ml-dfa-regression.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,8 @@ deployed and used as functions. The <<ml-inference-reg,{infer}>> feature enables
194194
you to use your model in a preprocessor of an ingest pipeline or in a pipeline
195195
aggregation of a search query to make predictions about your data.
196196

197+
include::ml-dfa-shared.asciidoc[tag=dfa-deploy-model]
198+
197199

198200
[discrete]
199201
[[ml-inference-reg]]

docs/en/stack/ml/df-analytics/ml-dfa-shared.asciidoc

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
1+
tag::dfa-deploy-model[]
2+
. To deploy {dfanalytics} model in a pipeline, navigate to **Machine Learning** >
3+
**Model Management** > **Trained models** in {kib}.
4+
5+
. Find the model you want to deploy in the list and click **Deploy model** in
6+
the **Actions** menu.
7+
+
8+
--
9+
[role="screenshot"]
10+
image::images/ml-dfa-trained-models-ui.png["The trained models UI in {kib}"]
11+
--
12+
13+
. Create an {infer} pipeline to be able to use the model against new data
14+
through the pipeline. Add a name and a description or use the default values.
15+
+
16+
--
17+
[role="screenshot"]
18+
image::images/ml-dfa-inference-pipeline.png["Creating an inference pipeline"]
19+
--
20+
21+
. Configure the pipeline processors or use the default settings.
22+
+
23+
--
24+
[role="screenshot"]
25+
image::images/ml-dfa-inference-processor.png["Configuring an inference processor"]
26+
--
27+
. Configure to handle ingest failures or use the default settings.
28+
29+
. (Optional) Test your pipeline by running a simulation of the pipeline to
30+
confirm it produces the anticipated results.
31+
32+
. Review the settings and click **Create pipeline**.
33+
34+
The model is deployed and ready to use through the {infer} pipeline.
35+
end::dfa-deploy-model[]
36+
37+
138
tag::dfa-evaluation-intro[]
239
Using the {dfanalytics} features to gain insights from a data set is an
340
iterative process. After you defined the problem you want to solve, and chose
@@ -18,10 +55,8 @@ the ground truth. The {evaluatedf-api} evaluates the performance of the
1855
end::dfa-evaluation-intro[]
1956

2057
tag::dfa-inference[]
21-
{infer-cap} is a {ml} feature that enables you to use supervised {ml} processes
22-
– like {regression} or {classification} – not only as a batch analysis but in a
23-
continuous fashion. This means that {infer} makes it possible to use
24-
<<ml-trained-models,trained {ml} models>> against incoming data.
58+
{infer-cap} enables you to use <<ml-trained-models,trained {ml} models>> against
59+
incoming data in a continuous fashion.
2560

2661
For instance, suppose you have an online service and you would like to predict
2762
whether a customer is likely to churn. You have an index with historical data –
@@ -43,7 +78,7 @@ are indexed into the destination index.
4378

4479
Check the {ref}/inference-processor.html[{infer} processor] and
4580
{ref}/ml-df-analytics-apis.html[the {ml} {dfanalytics} API documentation] to
46-
learn more about the feature.
81+
learn more.
4782
end::dfa-inference-processor[]
4883

4984
tag::dfa-inference-aggregation[]
@@ -58,7 +93,7 @@ to set up a processor in the ingest pipeline.
5893
Check the
5994
{ref}/search-aggregations-pipeline-inference-bucket-aggregation.html[{infer} bucket aggregation]
6095
and {ref}/ml-df-analytics-apis.html[the {ml} {dfanalytics} API documentation] to
61-
learn more about the feature.
96+
learn more.
6297

6398
NOTE: If you use trained model aliases to reference your trained model in an
6499
{infer} processor or {infer} aggregation, you can replace your trained model

docs/en/stack/ml/df-analytics/ml-trained-models.asciidoc

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@ information about this process, see <<ml-supervised-workflow>> and
1212
<<ml-inference-class,{infer} for {classification}>> and
1313
<<ml-inference-reg,{regression}>>.
1414

15-
You can also supply trained models that are not created by {dfanalytics-job} but
16-
adhere to the appropriate
17-
https://github.com/elastic/ml-json-schemas[JSON schema]. Likewise, you can use
18-
third-party models to perform natural language processing (NLP) tasks. If you
19-
want to use these trained models in the {stack}, you must store them in {es}
20-
documents by using the {ref}/put-trained-models.html[create trained models API].
21-
For more information about NLP models, refer to <<ml-nlp-deploy-models>>.
22-
2315
In {kib}, you can view and manage your trained models in
2416
*{stack-manage-app}* > *Alerts and Insights* > *{ml-app}* and
2517
*{ml-app}* > *Model Management*.
@@ -28,6 +20,27 @@ Alternatively, you can use APIs like
2820
{ref}/get-trained-models.html[get trained models] and
2921
{ref}/delete-trained-models.html[delete trained models].
3022

23+
[discrete]
24+
[[deploy-dfa-trained-models]]
25+
== Deploying trained models
26+
27+
[discrete]
28+
=== Models trained by {dfanalytics}
29+
30+
include::ml-dfa-shared.asciidoc[tag=dfa-deploy-model]
31+
32+
33+
[discrete]
34+
=== Models trained by other methods
35+
36+
You can also supply trained models that are not created by {dfanalytics-job} but
37+
adhere to the appropriate
38+
https://github.com/elastic/ml-json-schemas[JSON schema]. Likewise, you can use
39+
third-party models to perform natural language processing (NLP) tasks. If you
40+
want to use these trained models in the {stack}, you must store them in {es}
41+
documents by using the {ref}/put-trained-models.html[create trained models API].
42+
For more information about NLP models, refer to <<ml-nlp-deploy-models>>.
43+
3144

3245
[discrete]
3346
[[export-import]]

0 commit comments

Comments
 (0)