Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.Types.HyperParameterAlgorithmSpecification

Description

Documentation

data HyperParameterAlgorithmSpecification Source #

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

See: newHyperParameterAlgorithmSpecification smart constructor.

Constructors

HyperParameterAlgorithmSpecification'

Fields

algorithmName :: Maybe Text
The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.
trainingImage :: Maybe Text
The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
metricDefinitions :: Maybe [MetricDefinition]
An array of MetricDefinition objects that specify the metrics that the algorithm emits.
trainingInputMode :: TrainingInputMode

Instances

Instances details

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

newHyperParameterAlgorithmSpecification Source #

Arguments

:: TrainingInputMode	`$sel:trainingInputMode:HyperParameterAlgorithmSpecification'`
-> HyperParameterAlgorithmSpecification

Create a value of HyperParameterAlgorithmSpecification 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:algorithmName:HyperParameterAlgorithmSpecification', hyperParameterAlgorithmSpecification_algorithmName - The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

$sel:trainingImage:HyperParameterAlgorithmSpecification', hyperParameterAlgorithmSpecification_trainingImage - The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

$sel:metricDefinitions:HyperParameterAlgorithmSpecification', hyperParameterAlgorithmSpecification_metricDefinitions - An array of MetricDefinition objects that specify the metrics that the algorithm emits.

$sel:trainingInputMode:HyperParameterAlgorithmSpecification', hyperParameterAlgorithmSpecification_trainingInputMode - Undocumented member.

hyperParameterAlgorithmSpecification_algorithmName :: Lens' HyperParameterAlgorithmSpecification (Maybe Text) Source #

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

hyperParameterAlgorithmSpecification_trainingImage :: Lens' HyperParameterAlgorithmSpecification (Maybe Text) Source #

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

hyperParameterAlgorithmSpecification_metricDefinitions :: Lens' HyperParameterAlgorithmSpecification (Maybe [MetricDefinition]) Source #

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

hyperParameterAlgorithmSpecification_trainingInputMode :: Lens' HyperParameterAlgorithmSpecification TrainingInputMode Source #

Undocumented member.