Metric Definitions

Accessors to retrieve metric definition for training jobs.

sagemaker.metric_definitions.retrieve_default(region=None, model_id=None, model_version=None, instance_type=None, tolerate_vulnerable_model=False, tolerate_deprecated_model=False, sagemaker_session=<sagemaker.session.Session object>)

Retrieves the default training metric definitions for the model matching the given arguments.

Parameters

  • region (str) – The AWS Region for which to retrieve the default default training metric definitions. Defaults to None.

  • model_id (str) – The model ID of the model for which to retrieve the default training metric definitions. (Default: None).

  • model_version (str) – The version of the model for which to retrieve the default training metric definitions. (Default: None).

  • instance_type (str) – An instance type to optionally supply in order to get metric definitions specific for the instance type.

  • tolerate_vulnerable_model (bool) – True if vulnerable versions of model specifications should be tolerated (exception not raised). If False, raises an exception if the script used by this version of the model has dependencies with known security vulnerabilities. (Default: False).

  • tolerate_deprecated_model (bool) – True if deprecated models should be tolerated (exception not raised). False if these models should raise an exception. (Default: False).

  • sagemaker_session (sagemaker.session.Session) – A SageMaker Session object, used for SageMaker interactions. If not specified, one is created using the default AWS configuration chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).

Returns

The default metric definitions to use for the model or None.

Return type

list

Raises

ValueError – If the combination of arguments specified is not supported.