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 |
Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.
Trial components include pre-processing jobs, training jobs, and batch transform jobs.
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 a trial component and then use the Search API to search for the tags.
Synopsis
- data CreateTrialComponent = CreateTrialComponent' {
- displayName :: Maybe Text
- endTime :: Maybe POSIX
- inputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)
- metadataProperties :: Maybe MetadataProperties
- outputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)
- parameters :: Maybe (HashMap Text TrialComponentParameterValue)
- startTime :: Maybe POSIX
- status :: Maybe TrialComponentStatus
- tags :: Maybe [Tag]
- trialComponentName :: Text
- newCreateTrialComponent :: Text -> CreateTrialComponent
- createTrialComponent_displayName :: Lens' CreateTrialComponent (Maybe Text)
- createTrialComponent_endTime :: Lens' CreateTrialComponent (Maybe UTCTime)
- createTrialComponent_inputArtifacts :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentArtifact))
- createTrialComponent_metadataProperties :: Lens' CreateTrialComponent (Maybe MetadataProperties)
- createTrialComponent_outputArtifacts :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentArtifact))
- createTrialComponent_parameters :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentParameterValue))
- createTrialComponent_startTime :: Lens' CreateTrialComponent (Maybe UTCTime)
- createTrialComponent_status :: Lens' CreateTrialComponent (Maybe TrialComponentStatus)
- createTrialComponent_tags :: Lens' CreateTrialComponent (Maybe [Tag])
- createTrialComponent_trialComponentName :: Lens' CreateTrialComponent Text
- data CreateTrialComponentResponse = CreateTrialComponentResponse' {}
- newCreateTrialComponentResponse :: Int -> CreateTrialComponentResponse
- createTrialComponentResponse_trialComponentArn :: Lens' CreateTrialComponentResponse (Maybe Text)
- createTrialComponentResponse_httpStatus :: Lens' CreateTrialComponentResponse Int
Creating a Request
data CreateTrialComponent Source #
See: newCreateTrialComponent
smart constructor.
CreateTrialComponent' | |
|
Instances
newCreateTrialComponent Source #
Create a value of CreateTrialComponent
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:
CreateTrialComponent
, createTrialComponent_displayName
- The name of the component as displayed. The name doesn't need to be
unique. If DisplayName
isn't specified, TrialComponentName
is
displayed.
CreateTrialComponent
, createTrialComponent_endTime
- When the component ended.
CreateTrialComponent
, createTrialComponent_inputArtifacts
- The input artifacts for the component. Examples of input artifacts are
datasets, algorithms, hyperparameters, source code, and instance types.
CreateTrialComponent
, createTrialComponent_metadataProperties
- Undocumented member.
CreateTrialComponent
, createTrialComponent_outputArtifacts
- The output artifacts for the component. Examples of output artifacts are
metrics, snapshots, logs, and images.
CreateTrialComponent
, createTrialComponent_parameters
- The hyperparameters for the component.
CreateTrialComponent
, createTrialComponent_startTime
- When the component started.
CreateTrialComponent
, createTrialComponent_status
- The status of the component. States include:
- InProgress
- Completed
- Failed
CreateTrialComponent
, createTrialComponent_tags
- A list of tags to associate with the component. You can use Search API
to search on the tags.
CreateTrialComponent
, createTrialComponent_trialComponentName
- The name of the component. The name must be unique in your Amazon Web
Services account and is not case-sensitive.
Request Lenses
createTrialComponent_displayName :: Lens' CreateTrialComponent (Maybe Text) Source #
The name of the component as displayed. The name doesn't need to be
unique. If DisplayName
isn't specified, TrialComponentName
is
displayed.
createTrialComponent_endTime :: Lens' CreateTrialComponent (Maybe UTCTime) Source #
When the component ended.
createTrialComponent_inputArtifacts :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #
The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
createTrialComponent_metadataProperties :: Lens' CreateTrialComponent (Maybe MetadataProperties) Source #
Undocumented member.
createTrialComponent_outputArtifacts :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #
The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
createTrialComponent_parameters :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentParameterValue)) Source #
The hyperparameters for the component.
createTrialComponent_startTime :: Lens' CreateTrialComponent (Maybe UTCTime) Source #
When the component started.
createTrialComponent_status :: Lens' CreateTrialComponent (Maybe TrialComponentStatus) Source #
The status of the component. States include:
- InProgress
- Completed
- Failed
createTrialComponent_tags :: Lens' CreateTrialComponent (Maybe [Tag]) Source #
A list of tags to associate with the component. You can use Search API to search on the tags.
createTrialComponent_trialComponentName :: Lens' CreateTrialComponent Text Source #
The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
Destructuring the Response
data CreateTrialComponentResponse Source #
See: newCreateTrialComponentResponse
smart constructor.
CreateTrialComponentResponse' | |
|
Instances
newCreateTrialComponentResponse Source #
Create a value of CreateTrialComponentResponse
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:
CreateTrialComponentResponse
, createTrialComponentResponse_trialComponentArn
- The Amazon Resource Name (ARN) of the trial component.
$sel:httpStatus:CreateTrialComponentResponse'
, createTrialComponentResponse_httpStatus
- The response's http status code.
Response Lenses
createTrialComponentResponse_trialComponentArn :: Lens' CreateTrialComponentResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the trial component.
createTrialComponentResponse_httpStatus :: Lens' CreateTrialComponentResponse Int Source #
The response's http status code.