Amazon SageMaker Metrics Service

2024/09/20 - Amazon SageMaker Metrics Service - 1 new api methods

Changes  Amazon SageMaker now supports using manifest files to specify the location of uncompressed model artifacts within Model Packages

BatchGetMetrics (new) Link ΒΆ

Used to retrieve training metrics from SageMaker.

See also: AWS API Documentation

Request Syntax

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
        },
    ]
)
type MetricQueries

list

param MetricQueries

[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.

rtype

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) --