Amazonka.SageMaker.Types.ExperimentConfig

Documentation

data ExperimentConfig

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

• CreateProcessingJob
• CreateTrainingJob
• CreateTransformJob

See: newExperimentConfig smart constructor.

Constructors

ExperimentConfig'

Fields

• experimentName :: Maybe Text

  The name of an existing experiment to associate with the trial component.

• runName :: Maybe Text

  The name of the experiment run to associate with the trial component.

• trialComponentDisplayName :: Maybe Text

  The display name for the trial component. If this key isn't specified, the display name is the trial component name.

• trialName :: Maybe Text

  The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

Instances

FromJSON ExperimentConfig

Defined in Amazonka.SageMaker.Types.ExperimentConfig

Methods

parseJSON :: Value -> Parser ExperimentConfig

parseJSONList :: Value -> Parser [ExperimentConfig]

ToJSON ExperimentConfig

Defined in Amazonka.SageMaker.Types.ExperimentConfig

Methods

toJSON :: ExperimentConfig -> Value

toEncoding :: ExperimentConfig -> Encoding

toJSONList :: [ExperimentConfig] -> Value

toEncodingList :: [ExperimentConfig] -> Encoding

Generic ExperimentConfig

Defined in Amazonka.SageMaker.Types.ExperimentConfig

Associated Types

type Rep ExperimentConfig :: Type -> Type

Methods

from :: ExperimentConfig -> Rep ExperimentConfig x

to :: Rep ExperimentConfig x -> ExperimentConfig

Read ExperimentConfig

Defined in Amazonka.SageMaker.Types.ExperimentConfig

Methods

readsPrec :: Int -> ReadS ExperimentConfig

readList :: ReadS [ExperimentConfig]

readPrec :: ReadPrec ExperimentConfig

readListPrec :: ReadPrec [ExperimentConfig]

Show ExperimentConfig

Defined in Amazonka.SageMaker.Types.ExperimentConfig

Methods

showsPrec :: Int -> ExperimentConfig -> ShowS

show :: ExperimentConfig -> String

showList :: [ExperimentConfig] -> ShowS

NFData ExperimentConfig

Defined in Amazonka.SageMaker.Types.ExperimentConfig

Methods

rnf :: ExperimentConfig -> ()

Eq ExperimentConfig

Defined in Amazonka.SageMaker.Types.ExperimentConfig

Methods

(==) :: ExperimentConfig -> ExperimentConfig -> Bool

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

Hashable ExperimentConfig

Defined in Amazonka.SageMaker.Types.ExperimentConfig

Methods

hashWithSalt :: Int -> ExperimentConfig -> Int

hash :: ExperimentConfig -> Int

type Rep ExperimentConfig

Defined in Amazonka.SageMaker.Types.ExperimentConfig

type Rep ExperimentConfig = D1 ('MetaData "ExperimentConfig" "Amazonka.SageMaker.Types.ExperimentConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ExperimentConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "experimentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "runName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "trialComponentDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "trialName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newExperimentConfig :: ExperimentConfig

Create a value of ExperimentConfig 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:experimentName:ExperimentConfig', experimentConfig_experimentName - The name of an existing experiment to associate with the trial component.

$sel:runName:ExperimentConfig', experimentConfig_runName - The name of the experiment run to associate with the trial component.

$sel:trialComponentDisplayName:ExperimentConfig', experimentConfig_trialComponentDisplayName - The display name for the trial component. If this key isn't specified, the display name is the trial component name.

$sel:trialName:ExperimentConfig', experimentConfig_trialName - The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

experimentConfig_experimentName :: Lens' ExperimentConfig (Maybe Text)

The name of an existing experiment to associate with the trial component.

experimentConfig_runName :: Lens' ExperimentConfig (Maybe Text)

The name of the experiment run to associate with the trial component.

experimentConfig_trialComponentDisplayName :: Lens' ExperimentConfig (Maybe Text)

The display name for the trial component. If this key isn't specified, the display name is the trial component name.

experimentConfig_trialName :: Lens' ExperimentConfig (Maybe Text)

The name of an existing trial to associate the trial component with. If not specified, a new trial is created.