Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.HyperParameterTuningJobObjective

Description

Synopsis

Documentation

data HyperParameterTuningJobObjective Source #

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

See: newHyperParameterTuningJobObjective smart constructor.

Constructors

HyperParameterTuningJobObjective'
Fields type' :: HyperParameterTuningJobObjectiveType Whether to minimize or maximize the objective metric. metricName :: Text The name of the metric to use for the objective metric.

Instances

Instances details

FromJSON HyperParameterTuningJobObjective Source #
Instance details Defined in Amazonka.SageMaker.Types.HyperParameterTuningJobObjective Methods parseJSON :: Value -> Parser HyperParameterTuningJobObjective # parseJSONList :: Value -> Parser [HyperParameterTuningJobObjective] #
ToJSON HyperParameterTuningJobObjective Source #
Instance details Defined in Amazonka.SageMaker.Types.HyperParameterTuningJobObjective Methods toJSON :: HyperParameterTuningJobObjective -> Value # toEncoding :: HyperParameterTuningJobObjective -> Encoding # toJSONList :: [HyperParameterTuningJobObjective] -> Value # toEncodingList :: [HyperParameterTuningJobObjective] -> Encoding #
Generic HyperParameterTuningJobObjective Source #
Instance details Defined in Amazonka.SageMaker.Types.HyperParameterTuningJobObjective Associated Types type Rep HyperParameterTuningJobObjective :: Type -> Type # Methods from :: HyperParameterTuningJobObjective -> Rep HyperParameterTuningJobObjective x # to :: Rep HyperParameterTuningJobObjective x -> HyperParameterTuningJobObjective #
Read HyperParameterTuningJobObjective Source #
Instance details Defined in Amazonka.SageMaker.Types.HyperParameterTuningJobObjective Methods readsPrec :: Int -> ReadS HyperParameterTuningJobObjective # readList :: ReadS [HyperParameterTuningJobObjective] # readPrec :: ReadPrec HyperParameterTuningJobObjective # readListPrec :: ReadPrec [HyperParameterTuningJobObjective] #
Show HyperParameterTuningJobObjective Source #
Instance details Defined in Amazonka.SageMaker.Types.HyperParameterTuningJobObjective Methods showsPrec :: Int -> HyperParameterTuningJobObjective -> ShowS # show :: HyperParameterTuningJobObjective -> String # showList :: [HyperParameterTuningJobObjective] -> ShowS #
NFData HyperParameterTuningJobObjective Source #
Instance details Defined in Amazonka.SageMaker.Types.HyperParameterTuningJobObjective Methods rnf :: HyperParameterTuningJobObjective -> () #
Eq HyperParameterTuningJobObjective Source #
Instance details Defined in Amazonka.SageMaker.Types.HyperParameterTuningJobObjective Methods (==) :: HyperParameterTuningJobObjective -> HyperParameterTuningJobObjective -> Bool # (/=) :: HyperParameterTuningJobObjective -> HyperParameterTuningJobObjective -> Bool #
Hashable HyperParameterTuningJobObjective Source #
Instance details Defined in Amazonka.SageMaker.Types.HyperParameterTuningJobObjective Methods hashWithSalt :: Int -> HyperParameterTuningJobObjective -> Int # hash :: HyperParameterTuningJobObjective -> Int #
type Rep HyperParameterTuningJobObjective Source #
Instance details Defined in Amazonka.SageMaker.Types.HyperParameterTuningJobObjective type Rep HyperParameterTuningJobObjective = D1 ('MetaData "HyperParameterTuningJobObjective" "Amazonka.SageMaker.Types.HyperParameterTuningJobObjective" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "HyperParameterTuningJobObjective'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HyperParameterTuningJobObjectiveType) :*: S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newHyperParameterTuningJobObjective Source #

Arguments

:: HyperParameterTuningJobObjectiveType	`$sel:type':HyperParameterTuningJobObjective'`
-> Text	`$sel:metricName:HyperParameterTuningJobObjective'`
-> HyperParameterTuningJobObjective

Create a value of HyperParameterTuningJobObjective 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:type':HyperParameterTuningJobObjective', hyperParameterTuningJobObjective_type - Whether to minimize or maximize the objective metric.

$sel:metricName:HyperParameterTuningJobObjective', hyperParameterTuningJobObjective_metricName - The name of the metric to use for the objective metric.

hyperParameterTuningJobObjective_type :: Lens' HyperParameterTuningJobObjective HyperParameterTuningJobObjectiveType Source #

Whether to minimize or maximize the objective metric.

hyperParameterTuningJobObjective_metricName :: Lens' HyperParameterTuningJobObjective Text Source #

The name of the metric to use for the objective metric.