| 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.CreateExperiment
Description
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.
Synopsis
- data CreateExperiment = CreateExperiment' {
- description :: Maybe Text
- displayName :: Maybe Text
- tags :: Maybe [Tag]
- experimentName :: Text
- newCreateExperiment :: Text -> CreateExperiment
- createExperiment_description :: Lens' CreateExperiment (Maybe Text)
- createExperiment_displayName :: Lens' CreateExperiment (Maybe Text)
- createExperiment_tags :: Lens' CreateExperiment (Maybe [Tag])
- createExperiment_experimentName :: Lens' CreateExperiment Text
- data CreateExperimentResponse = CreateExperimentResponse' {
- experimentArn :: Maybe Text
- httpStatus :: Int
- newCreateExperimentResponse :: Int -> CreateExperimentResponse
- createExperimentResponse_experimentArn :: Lens' CreateExperimentResponse (Maybe Text)
- createExperimentResponse_httpStatus :: Lens' CreateExperimentResponse Int
Creating a Request
data CreateExperiment Source #
See: newCreateExperiment smart constructor.
Constructors
| CreateExperiment' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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) Source #
The description of the experiment.
createExperiment_displayName :: Lens' CreateExperiment (Maybe Text) Source #
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]) Source #
A list of tags to associate with the experiment. You can use Search API to search on the tags.
createExperiment_experimentName :: Lens' CreateExperiment Text Source #
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 Source #
See: newCreateExperimentResponse smart constructor.
Constructors
| CreateExperimentResponse' | |
Fields
| |
Instances
newCreateExperimentResponse Source #
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) Source #
The Amazon Resource Name (ARN) of the experiment.
createExperimentResponse_httpStatus :: Lens' CreateExperimentResponse Int Source #
The response's http status code.