SageMakerMetrics / Client / batch_get_metrics

batch_get_metrics

SageMakerMetrics.Client.batch_get_metrics(**kwargs)

Used to retrieve training metrics from SageMaker.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_metrics(
    MetricQueries=[
        {
            'MetricName': 'string',
            'ResourceArn': 'string',
            'MetricStat': 'Min'|'Max'|'Avg'|'Count'|'StdDev'|'Last',
            'Period': 'OneMinute'|'FiveMinute'|'OneHour'|'IterationNumber',
            'XAxisType': 'IterationNumber'|'Timestamp',
            'Start': 123,
            'End': 123
        },
    ]
)

Parameters:

MetricQueries (list) –

[REQUIRED]

Queries made to retrieve training metrics from SageMaker.

• (dict) –

  Specifies a query to retrieve training metrics from SageMaker.

  • MetricName (string) – [REQUIRED]

    The name of the metric to retrieve.

  • ResourceArn (string) – [REQUIRED]

    The ARN of the SageMaker resource to retrieve metrics for.

  • MetricStat (string) – [REQUIRED]

    The metrics stat type of metrics to retrieve.

  • Period (string) – [REQUIRED]

    The time period of metrics to retrieve.

  • XAxisType (string) – [REQUIRED]

    The x-axis type of metrics to retrieve.

  • Start (integer) –

    The start time of metrics to retrieve.

  • End (integer) –

    The end time of metrics to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'MetricQueryResults': [
        {
            'Status': 'Complete'|'Truncated'|'InternalError'|'ValidationError',
            'Message': 'string',
            'XAxisValues': [
                123,
            ],
            'MetricValues': [
                123.0,
            ]
        },
    ]
}

Response Structure

• (dict) –

  • MetricQueryResults (list) –

    The results of a query to retrieve training metrics from SageMaker.

    • (dict) –

      The result of a query to retrieve training metrics from SageMaker.

      • Status (string) –

        The status of the metric query.

      • Message (string) –

        A message describing the status of the metric query.

      • XAxisValues (list) –

        The values for the x-axis of the metrics.

        • (integer) –

      • MetricValues (list) –

        The metric values retrieved by the query.

        • (float) –