Skip to content

Commit 40a5206

Browse files
committed
Adds warning to Create inference API page (#118073)
1 parent fbb42f1 commit 40a5206

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/reference/inference/put-inference.asciidoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Creates an {infer} endpoint to perform an {infer} task.
1010
* For built-in models and models uploaded through Eland, the {infer} APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the {infer} APIs to use these models or if you want to use non-NLP models, use the <<ml-df-trained-models-apis>>.
1111
====
1212

13-
1413
[discrete]
1514
[[put-inference-api-request]]
1615
==== {api-request-title}
@@ -47,6 +46,14 @@ Refer to the service list in the <<put-inference-api-desc,API description sectio
4746

4847
The create {infer} API enables you to create an {infer} endpoint and configure a {ml} model to perform a specific {infer} task.
4948

49+
[IMPORTANT]
50+
====
51+
* When creating an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
52+
* After creating the endpoint, wait for the model deployment to complete before using it. You can verify the deployment status by using the <<get-trained-models-stats, Get trained model statistics>> API. In the response, look for `"state": "fully_allocated"` and ensure the `"allocation_count"` matches the `"target_allocation_count"`.
53+
* Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
54+
====
55+
56+
5057
The following services are available through the {infer} API.
5158
You can find the available task types next to the service name.
5259
Click the links to review the configuration details of the services:

0 commit comments

Comments
 (0)