Update a trained model deployment

POST /_ml/trained_models/{model_id}/deployment/_update

Api key auth Basic auth Bearer auth

Required authorization

Cluster privileges: manage_ml

Path Parameters

model_id string Id required: The unique identifier of the trained model. Currently, only PyTorch models are supported.

Query Parameters

number_of_allocations number · default: 1: The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads.

Request

Response

application/json

Examples

An example body for a POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update request.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update
{
  "number_of_allocations": 4
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.updateTrainedModelDeployment({
  model_id: "elastic__distilbert-base-uncased-finetuned-conll03-english",
  number_of_allocations: 4,
});

Python Elasticsearch Python Client

resp = client.ml.update_trained_model_deployment(
    model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
    number_of_allocations=4,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "number_of_allocations": 4
  }'

Java Elasticsearch Java Client

client.ml().updateTrainedModelDeployment(u -> u
    .modelId("elastic__distilbert-base-uncased-finetuned-conll03-english")
    .numberOfAllocations(4)
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .UpdateTrainedModelDeploymentAsync(modelId: "elastic__distilbert-base-uncased-finetuned-conll03-english", d1 => d1
        .NumberOfAllocations(4)
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->updateTrainedModelDeployment([
    "model_id" => "elastic__distilbert-base-uncased-finetuned-conll03-english",
    "body" => [
        "number_of_allocations" => 4,
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.update_trained_model_deployment(
  model_id: "elastic__distilbert-base-uncased-finetuned-conll03-english",
  body: {
    "number_of_allocations": 4
  }
)

Response

No example

Required authorization

Path Parameters

Query Parameters

Request { number_of_allocations , adaptive_allocations , }

Response

Request