sagemaker.core.telemetry.telemetry_logging

Telemetry module for SageMaker Python SDK to collect usage data and metrics.

Classes

TelemetryParamType()

Constants for telemetry parameter extraction types.

class sagemaker.core.telemetry.telemetry_logging.TelemetryParamType

Bases: object

Constants for telemetry parameter extraction types.

Used in the telemetry_params list passed to @_telemetry_emitter decorator. Each entry in telemetry_params is a tuple of (name, type) or (name, type, value).

To add a new telemetry signal to any class: 1. Identify what you want to track (instance attribute, method return, or kwarg). 2. Pick the appropriate type constant below. 3. Add a tuple to the telemetry_params list on the decorator.

Example

@_telemetry_emitter(

feature=Feature.MODEL_CUSTOMIZATION, func_name=”MyClass.my_method”, telemetry_params=[

(“model_name”, TelemetryParamType.ATTR_VALUE), # emits x-modelName=<value> (“networking”, TelemetryParamType.ATTR_EXISTS), # emits x-hasNetworking=true/false (“_is_fine_tuned”, TelemetryParamType.ATTR_CALL), # emits x-isFineTuned=True/False (“instance_type”, TelemetryParamType.KWARG_VALUE), # emits x-instanceType=<kwarg value> (“kms_key_id”, TelemetryParamType.KWARG_EXISTS), # emits x-hasKmsKeyId=true/false

],

)

ATTR_CALL = 'attr_call'

ATTR_EXISTS = 'attr_exists'

ATTR_TYPE = 'attr_type'

ATTR_VALUE = 'attr_value'

KWARG_EXISTS = 'kwarg_exists'

KWARG_VALUE = 'kwarg_value'