Amazonka.SageMaker.CreateExperiment

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

Creating a Request

data CreateExperiment

See: newCreateExperiment smart constructor.

Constructors

CreateExperiment'

Fields

• description :: Maybe Text

  The description of the experiment.

• displayName :: Maybe Text

  The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

• tags :: Maybe [Tag]

  A list of tags to associate with the experiment. You can use Search API to search on the tags.

• experimentName :: Text

  The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Instances

ToJSON CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Methods

toJSON :: CreateExperiment -> Value

toEncoding :: CreateExperiment -> Encoding

toJSONList :: [CreateExperiment] -> Value

toEncodingList :: [CreateExperiment] -> Encoding

ToHeaders CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Methods

toHeaders :: CreateExperiment -> [Header]

ToPath CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Methods

toPath :: CreateExperiment -> ByteString

ToQuery CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Methods

toQuery :: CreateExperiment -> QueryString

AWSRequest CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Associated Types

type AWSResponse CreateExperiment

Methods

request :: (Service -> Service) -> CreateExperiment -> Request CreateExperiment

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateExperiment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateExperiment)))

Generic CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Associated Types

type Rep CreateExperiment :: Type -> Type

Methods

from :: CreateExperiment -> Rep CreateExperiment x

to :: Rep CreateExperiment x -> CreateExperiment

Read CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Methods

readsPrec :: Int -> ReadS CreateExperiment

readList :: ReadS [CreateExperiment]

readPrec :: ReadPrec CreateExperiment

readListPrec :: ReadPrec [CreateExperiment]

Show CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Methods

showsPrec :: Int -> CreateExperiment -> ShowS

show :: CreateExperiment -> String

showList :: [CreateExperiment] -> ShowS

NFData CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Methods

rnf :: CreateExperiment -> ()

Eq CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Methods

(==) :: CreateExperiment -> CreateExperiment -> Bool

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

Hashable CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

Methods

hashWithSalt :: Int -> CreateExperiment -> Int

hash :: CreateExperiment -> Int

type AWSResponse CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

type AWSResponse CreateExperiment = CreateExperimentResponse

type Rep CreateExperiment

Defined in Amazonka.SageMaker.CreateExperiment

type Rep CreateExperiment = D1 ('MetaData "CreateExperiment" "Amazonka.SageMaker.CreateExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateExperiment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "experimentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateExperiment

Arguments

:: Text

CreateExperiment

-> CreateExperiment

Create a value of CreateExperiment 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:

CreateExperiment, createExperiment_description - The description of the experiment.

CreateExperiment, createExperiment_displayName - The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

CreateExperiment, createExperiment_tags - A list of tags to associate with the experiment. You can use Search API to search on the tags.

CreateExperiment, createExperiment_experimentName - The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Request Lenses

createExperiment_description :: Lens' CreateExperiment (Maybe Text)

The description of the experiment.

createExperiment_displayName :: Lens' CreateExperiment (Maybe Text)

The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

createExperiment_tags :: Lens' CreateExperiment (Maybe [Tag])

A list of tags to associate with the experiment. You can use Search API to search on the tags.

createExperiment_experimentName :: Lens' CreateExperiment Text

The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Destructuring the Response

data CreateExperimentResponse

See: newCreateExperimentResponse smart constructor.

Constructors

CreateExperimentResponse'

Fields

• experimentArn :: Maybe Text

  The Amazon Resource Name (ARN) of the experiment.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateExperimentResponse

Defined in Amazonka.SageMaker.CreateExperiment

Associated Types

type Rep CreateExperimentResponse :: Type -> Type

Methods

from :: CreateExperimentResponse -> Rep CreateExperimentResponse x

to :: Rep CreateExperimentResponse x -> CreateExperimentResponse

Read CreateExperimentResponse

Defined in Amazonka.SageMaker.CreateExperiment

Methods

readsPrec :: Int -> ReadS CreateExperimentResponse

readList :: ReadS [CreateExperimentResponse]

readPrec :: ReadPrec CreateExperimentResponse

readListPrec :: ReadPrec [CreateExperimentResponse]

Show CreateExperimentResponse

Defined in Amazonka.SageMaker.CreateExperiment

Methods

showsPrec :: Int -> CreateExperimentResponse -> ShowS

show :: CreateExperimentResponse -> String

showList :: [CreateExperimentResponse] -> ShowS

NFData CreateExperimentResponse

Defined in Amazonka.SageMaker.CreateExperiment

Methods

rnf :: CreateExperimentResponse -> ()

Eq CreateExperimentResponse

Defined in Amazonka.SageMaker.CreateExperiment

Methods

(==) :: CreateExperimentResponse -> CreateExperimentResponse -> Bool

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

type Rep CreateExperimentResponse

Defined in Amazonka.SageMaker.CreateExperiment

type Rep CreateExperimentResponse = D1 ('MetaData "CreateExperimentResponse" "Amazonka.SageMaker.CreateExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateExperimentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "experimentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateExperimentResponse

Arguments

:: Int

$sel:httpStatus:CreateExperimentResponse'

-> CreateExperimentResponse

Create a value of CreateExperimentResponse 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:

CreateExperimentResponse, createExperimentResponse_experimentArn - The Amazon Resource Name (ARN) of the experiment.

$sel:httpStatus:CreateExperimentResponse', createExperimentResponse_httpStatus - The response's http status code.

Response Lenses

createExperimentResponse_experimentArn :: Lens' CreateExperimentResponse (Maybe Text)

The Amazon Resource Name (ARN) of the experiment.

createExperimentResponse_httpStatus :: Lens' CreateExperimentResponse Int

The response's http status code.