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.HyperParameterSpecification

Description

Synopsis

data HyperParameterSpecification = HyperParameterSpecification' {
- isTunable :: Maybe Bool
- range :: Maybe ParameterRange
- defaultValue :: Maybe Text
- isRequired :: Maybe Bool
- description :: Maybe Text
- name :: Text
- type' :: ParameterType
}
newHyperParameterSpecification :: Text -> ParameterType -> HyperParameterSpecification
hyperParameterSpecification_isTunable :: Lens' HyperParameterSpecification (Maybe Bool)
hyperParameterSpecification_range :: Lens' HyperParameterSpecification (Maybe ParameterRange)
hyperParameterSpecification_defaultValue :: Lens' HyperParameterSpecification (Maybe Text)
hyperParameterSpecification_isRequired :: Lens' HyperParameterSpecification (Maybe Bool)
hyperParameterSpecification_description :: Lens' HyperParameterSpecification (Maybe Text)
hyperParameterSpecification_name :: Lens' HyperParameterSpecification Text
hyperParameterSpecification_type :: Lens' HyperParameterSpecification ParameterType

Documentation

data HyperParameterSpecification Source #

Defines a hyperparameter to be used by an algorithm.

See: newHyperParameterSpecification smart constructor.

Constructors

HyperParameterSpecification'

Fields

isTunable :: Maybe Bool
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
range :: Maybe ParameterRange
The allowed range for this hyperparameter.
defaultValue :: Maybe Text
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
isRequired :: Maybe Bool
Indicates whether this hyperparameter is required.
description :: Maybe Text
A brief description of the hyperparameter.
name :: Text
The name of this hyperparameter. The name must be unique.
type' :: ParameterType
The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Instances

Instances details

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

newHyperParameterSpecification Source #

Arguments

:: Text	`$sel:name:HyperParameterSpecification'`
-> ParameterType	`$sel:type':HyperParameterSpecification'`
-> HyperParameterSpecification

Create a value of HyperParameterSpecification 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:isTunable:HyperParameterSpecification', hyperParameterSpecification_isTunable - Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

$sel:range:HyperParameterSpecification', hyperParameterSpecification_range - The allowed range for this hyperparameter.

$sel:defaultValue:HyperParameterSpecification', hyperParameterSpecification_defaultValue - The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

$sel:isRequired:HyperParameterSpecification', hyperParameterSpecification_isRequired - Indicates whether this hyperparameter is required.

$sel:description:HyperParameterSpecification', hyperParameterSpecification_description - A brief description of the hyperparameter.

$sel:name:HyperParameterSpecification', hyperParameterSpecification_name - The name of this hyperparameter. The name must be unique.

$sel:type':HyperParameterSpecification', hyperParameterSpecification_type - The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

hyperParameterSpecification_isTunable :: Lens' HyperParameterSpecification (Maybe Bool) Source #

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

hyperParameterSpecification_range :: Lens' HyperParameterSpecification (Maybe ParameterRange) Source #

The allowed range for this hyperparameter.

hyperParameterSpecification_defaultValue :: Lens' HyperParameterSpecification (Maybe Text) Source #

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

hyperParameterSpecification_isRequired :: Lens' HyperParameterSpecification (Maybe Bool) Source #

Indicates whether this hyperparameter is required.

hyperParameterSpecification_description :: Lens' HyperParameterSpecification (Maybe Text) Source #

A brief description of the hyperparameter.

hyperParameterSpecification_name :: Lens' HyperParameterSpecification Text Source #

The name of this hyperparameter. The name must be unique.

hyperParameterSpecification_type :: Lens' HyperParameterSpecification ParameterType Source #

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.