Amazon SageMaker Metrics Service

Used to ingest training metrics into SageMaker which can be visualized in SageMaker Studio and retrieved with the GetMetrics API.

See also: AWS API Documentation

Request Syntax

client.batch_put_metrics(
    TrialComponentName='string',
    MetricData=[
        {
            'MetricName': 'string',
            'Timestamp': datetime(2015, 1, 1),
            'Step': 123,
            'Value': 123.0
        },
    ]
)

type TrialComponentName:

string

param TrialComponentName:

[REQUIRED]

The name of Trial Component to associate the metrics with.

type MetricData:

list

param MetricData:

[REQUIRED]

A list of raw metric values to put.

• (dict) --

  The raw metric data to associate with the resource.

  • MetricName (string) -- [REQUIRED]

    The name of the metric.

  • Timestamp (datetime) -- [REQUIRED]

    The time when the metric was recorded.

  • Step (integer) --

    Metric step (aka Epoch).

  • Value (float) -- [REQUIRED]

    The metric value.

rtype:

dict

returns:

Response Syntax

{
    'Errors': [
        {
            'Code': 'METRIC_LIMIT_EXCEEDED'|'INTERNAL_ERROR'|'VALIDATION_ERROR'|'CONFLICT_ERROR',
            'MetricIndex': 123
        },
    ]
}

Response Structure

• (dict) --

  • Errors (list) --

    Any errors that occur when inserting metric data will appear in this.

    • (dict) --

      An error that occured when putting the metric data.

      • Code (string) --

        The error code of an error that occured when attempting to put metrics.

        • METRIC_LIMIT_EXCEEDED - The max amount of metrics per resource has been exceeded.

        • INTERNAL_ERROR - An internal error occured.

        • VALIDATION_ERROR - The metric data failed validation.

        • CONFLICT_ERROR - Multiple requests attempted to modify the same data simultaneously.

      • MetricIndex (integer) --

        An index that corresponds to the metric in the request.