metrics

Creates, updates, deletes, gets or lists a metrics resource.

Overview

Name	metrics
Type	Resource
Id	aws.sagemaker_metrics.metrics

Fields

The following fields are returned by SELECT queries:

batch_get_metrics

Name	Datatype	Description
metric_query_results	array	The results of a query to retrieve training metrics from SageMaker.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_metrics	select	region		Used to retrieve training metrics from SageMaker.
batch_put_metrics	exec	region, TrialComponentName, MetricData		Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_metrics

Used to retrieve training metrics from SageMaker.

SELECT
metric_query_results
FROM aws.sagemaker_metrics.metrics
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

batch_put_metrics

Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio.

EXEC aws.sagemaker_metrics.metrics.batch_put_metrics 
@region='{{ region }}' --required 
@@json=
'{
"TrialComponentName": "{{ TrialComponentName }}", 
"MetricData": "{{ MetricData }}"
}'
;