Get trained models usage info
- GET /_ml/trained_models/{model_id}/_stats
- GET /_ml/trained_models/_stats
You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.
- Cluster privileges:
monitor_ml
Path Parameters
-
model_idId | Idoptional -
The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression.
Leave it out to use
/_ml/trained_models/_stats.
Query Parameters
-
allow_no_matchboolean · default: true Specifies what to do when the request:
- Contains wildcard expressions and there are no models that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches.
If true, it returns an empty array when there are no matches and the subset of results when there are partial matches.
-
fromnumber · default: 0 Skips the specified number of models.
-
sizenumber · default: 100 Specifies the maximum number of models to obtain.
Response
-
countnumberrequired -
The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter.
-
trained_model_statsTrainedModelStatsrequired -
An array of trained model statistics, which are sorted by the model_id value in ascending order.
-
deployment_statsTrainedModelDeploymentStats -
A collection of deployment stats, which is present when the models are deployed.
-
adaptive_allocationsAdaptiveAllocationsSettings -
enabledbooleanrequired -
If true, adaptive_allocations is enabled
-
min_number_of_allocationsnumber -
Specifies the minimum number of allocations to scale to. If set, it must be greater than or equal to 0. If not defined, the deployment scales to 0.
-
max_number_of_allocationsnumber -
Specifies the maximum number of allocations to scale to. If set, it must be greater than or equal to min_number_of_allocations.
-
allocation_statusTrainedModelDeploymentAllocationStatus -
The detailed allocation status for the deployment.
-
allocation_countnumberrequired -
The current number of nodes where the model is allocated.
-
stateDeploymentAllocationStaterequired -
The detailed allocation state related to the nodes.
Supported values include:
started: The trained model is started on at least one node.starting: Trained model deployment is starting but it is not yet deployed on any nodes.fully_allocated: Trained model deployment has started on all valid nodes.
-
Values:
startedstartingfully_allocated -
target_allocation_countnumberrequired -
The desired number of nodes for model allocation.
-
cache_sizenumber | string ByteSize -
deployment_idstring Idrequired -
The unique identifier for the trained model deployment.
-
error_countnumber -
The sum of
error_countfor all nodes in the deployment. -
inference_countnumber -
The sum of
inference_countfor all nodes in the deployment. -
model_idstring Idrequired -
The unique identifier for the trained model.
-
nodesTrainedModelDeploymentNodesStatsrequired -
The deployment stats for each node that currently has the model allocated. In serverless, stats are reported for a single unnamed virtual node.
-
average_inference_time_msDurationValueUnitFloatMillis -
The average time for each inference call to complete on this node.
-
average_inference_time_ms_last_minuteDurationValueUnitFloatMillis -
average_inference_time_ms_excluding_cache_hitsDurationValueUnitFloatMillis -
The average time for each inference call to complete on this node, excluding cache
-
average_inference_process_memory_rss_bytesnumber | string ByteSize -
error_countnumber -
The number of errors when evaluating the trained model.
-
inference_countnumber -
The total number of inference calls made against this node for this model.
-
inference_cache_hit_countnumber -
last_accessEpochTimeUnitMillis -
The epoch time stamp of the last inference call for the model on this node.
-
number_of_allocationsnumber -
The number of allocations assigned to this node.
-
number_of_pending_requestsnumber -
The number of inference requests queued to be processed.
-
peak_throughput_per_minutenumberrequired -
rejected_execution_countnumber -
The number of inference requests that were not processed because the queue was full.
-
routing_stateTrainedModelAssignmentRoutingStateAndReasonrequired -
The current routing state and reason for the current routing state for this allocation.
-
reasonstring -
The reason for the current state. It is usually populated only when the
routing_stateisfailed. -
routing_stateRoutingStaterequired -
The current routing state.
Supported values include:
failed: The allocation attempt failed.started: The trained model is allocated and ready to accept inference requests.starting: The trained model is attempting to allocate on this node; inference requests are not yet accepted.stopped: The trained model is fully deallocated from this node.stopping: The trained model is being deallocated from this node.
-
Values:
failedstartedstartingstoppedstopping -
start_timeEpochTimeUnitMillis -
The epoch timestamp when the allocation started.
-
threads_per_allocationnumber -
The number of threads used by each allocation during inference.
-
throughput_last_minutenumberrequired -
timeout_countnumber -
The number of inference requests that timed out before being processed.
-
number_of_allocationsnumber -
The number of allocations requested.
-
peak_throughput_per_minutenumberrequired -
priorityTrainingPriorityrequired -
Values:
normallow -
queue_capacitynumber -
The number of inference requests that can be queued before new requests are rejected.
-
rejected_execution_countnumber -
The sum of
rejected_execution_countfor all nodes in the deployment. Individual nodes reject an inference request if the inference queue is full. The queue size is controlled by thequeue_capacitysetting in the start trained model deployment API. -
reasonstring -
The reason for the current deployment state. Usually only populated when the model is not deployed to a node.
-
start_timeEpochTimeUnitMillisrequired -
The epoch timestamp when the deployment started.
-
stateDeploymentAssignmentState -
The overall state of the deployment.
Supported values include:
started: The deployment is usable; at least one node has the model allocated.starting: The deployment has recently started but is not yet usable; the model is not allocated on any nodes.stopping: The deployment is preparing to stop and deallocate the model from the relevant nodes.failed: The deployment is on a failed state and must be re-deployed.
-
Values:
startedstartingstoppingfailed -
threads_per_allocationnumber -
The number of threads used be each allocation during inference.
-
timeout_countnumber -
The sum of
timeout_countfor all nodes in the deployment. -
inference_statsTrainedModelInferenceStats -
A collection of inference stats fields.
-
cache_miss_countnumberrequired -
The number of times the model was loaded for inference and was not retrieved from the cache. If this number is close to the
inference_count, the cache is not being appropriately used. This can be solved by increasing the cache size or its time-to-live (TTL). Refer to general machine learning settings for the appropriate settings. -
failure_countnumberrequired -
The number of failures when using the model for inference.
-
inference_countnumberrequired -
The total number of times the model has been called for inference. This is across all inference contexts, including all pipelines.
-
missing_all_fields_countnumberrequired -
The number of inference calls where all the training features for the model were missing.
-
timestampEpochTimeUnitMillisrequired -
The time when the statistics were last updated.
-
ingestmap string to object -
A collection of ingest stats for the model across all nodes. The values are summations of the individual node statistics. The format matches the ingest section in the nodes stats API.
-
model_idstring Idrequired -
The unique identifier of the trained model.
-
model_size_statsTrainedModelSizeStatsrequired -
A collection of model size stats.
-
model_size_bytesnumber | string ByteSizerequired -
The size of the model in bytes.
-
required_native_memory_bytesnumber | string ByteSizerequired -
The amount of memory required to load the model in bytes.
-
pipeline_countnumberrequired -
The number of ingest pipelines that currently refer to the model.