flytekitplugins.awssagemaker.HyperparameterTuningObjective#

class flytekitplugins.awssagemaker.HyperparameterTuningObjective(objective_type, metric_name)[source]#

HyperparameterTuningObjective is a data structure that contains the target metric and the objective of the hyperparameter tuning.

https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html

Methods

Parameters
  • objective_type (int) –

  • metric_name (str) –

classmethod from_flyte_idl(pb2_object)[source]#
Parameters

pb2_object (flyteidl.plugins.sagemaker.hyperparameter_tuning_job_pb2.HyperparameterTuningObjective) –

serialize_to_string()#
Return type

str

short_string()#
Return type

Text

to_flyte_idl()[source]#
Return type

flyteidl.plugins.sagemaker.hyperparameter_tuning_job_pb2.HyperparameterTuningObjective

verbose_string()#
Return type

Text

Attributes

is_empty#
metric_name#

The target metric name, which is the user-defined name of the metric specified in the training job’s algorithm specification :rtype: str

objective_type#

Enum value of HyperparameterTuningObjectiveType. objective_type determines the direction of the tuning of the Hyperparameter Tuning Job with respect to the specified metric. :rtype: int