Amazonka.SageMaker.Types.MetricDefinition

Documentation

data MetricDefinition

Specifies a metric that the training algorithm writes to stderr or stdout. SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.

See: newMetricDefinition smart constructor.

Constructors

MetricDefinition'

Fields

• name :: Text

  The name of the metric.

• regex :: Text

  A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

Instances

FromJSON MetricDefinition

Defined in Amazonka.SageMaker.Types.MetricDefinition

Methods

parseJSON :: Value -> Parser MetricDefinition

parseJSONList :: Value -> Parser [MetricDefinition]

ToJSON MetricDefinition

Defined in Amazonka.SageMaker.Types.MetricDefinition

Methods

toJSON :: MetricDefinition -> Value

toEncoding :: MetricDefinition -> Encoding

toJSONList :: [MetricDefinition] -> Value

toEncodingList :: [MetricDefinition] -> Encoding

Generic MetricDefinition

Defined in Amazonka.SageMaker.Types.MetricDefinition

Associated Types

type Rep MetricDefinition :: Type -> Type

Methods

from :: MetricDefinition -> Rep MetricDefinition x

to :: Rep MetricDefinition x -> MetricDefinition

Read MetricDefinition

Defined in Amazonka.SageMaker.Types.MetricDefinition

Methods

readsPrec :: Int -> ReadS MetricDefinition

readList :: ReadS [MetricDefinition]

readPrec :: ReadPrec MetricDefinition

readListPrec :: ReadPrec [MetricDefinition]

Show MetricDefinition

Defined in Amazonka.SageMaker.Types.MetricDefinition

Methods

showsPrec :: Int -> MetricDefinition -> ShowS

show :: MetricDefinition -> String

showList :: [MetricDefinition] -> ShowS

NFData MetricDefinition

Defined in Amazonka.SageMaker.Types.MetricDefinition

Methods

rnf :: MetricDefinition -> ()

Eq MetricDefinition

Defined in Amazonka.SageMaker.Types.MetricDefinition

Methods

(==) :: MetricDefinition -> MetricDefinition -> Bool

(/=) :: MetricDefinition -> MetricDefinition -> Bool

Hashable MetricDefinition

Defined in Amazonka.SageMaker.Types.MetricDefinition

Methods

hashWithSalt :: Int -> MetricDefinition -> Int

hash :: MetricDefinition -> Int

type Rep MetricDefinition

Defined in Amazonka.SageMaker.Types.MetricDefinition

type Rep MetricDefinition = D1 ('MetaData "MetricDefinition" "Amazonka.SageMaker.Types.MetricDefinition" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "MetricDefinition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "regex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newMetricDefinition

Arguments

:: Text

$sel:name:MetricDefinition'

-> Text

$sel:regex:MetricDefinition'

-> MetricDefinition

Create a value of MetricDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:MetricDefinition', metricDefinition_name - The name of the metric.

$sel:regex:MetricDefinition', metricDefinition_regex - A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

metricDefinition_name :: Lens' MetricDefinition Text

The name of the metric.

metricDefinition_regex :: Lens' MetricDefinition Text

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.