/AWS1/CL_SGM=>CREATETRIALCOMPONENT()
¶
About CreateTrialComponent¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_TRIALCOMPONENTNAME
TYPE /AWS1/SGMEXPERIMENTENTITYNAME
/AWS1/SGMEXPERIMENTENTITYNAME
¶
The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
Optional arguments:¶
IV_DISPLAYNAME
TYPE /AWS1/SGMEXPERIMENTENTITYNAME
/AWS1/SGMEXPERIMENTENTITYNAME
¶
The name of the component as displayed. The name doesn't need to be unique. If
DisplayName
isn't specified,TrialComponentName
is displayed.
IO_STATUS
TYPE REF TO /AWS1/CL_SGMTRIALCOMPONENTSTAT
/AWS1/CL_SGMTRIALCOMPONENTSTAT
¶
The status of the component. States include:
InProgress
Completed
Failed
IV_STARTTIME
TYPE /AWS1/SGMTIMESTAMP
/AWS1/SGMTIMESTAMP
¶
When the component started.
IV_ENDTIME
TYPE /AWS1/SGMTIMESTAMP
/AWS1/SGMTIMESTAMP
¶
When the component ended.
IT_PARAMETERS
TYPE /AWS1/CL_SGMTRIALCOMPONENTPR00=>TT_TRIALCOMPONENTPARAMETERS
TT_TRIALCOMPONENTPARAMETERS
¶
The hyperparameters for the component.
IT_INPUTARTIFACTS
TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS
TT_TRIALCOMPONENTARTIFACTS
¶
The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
IT_OUTPUTARTIFACTS
TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS
TT_TRIALCOMPONENTARTIFACTS
¶
The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
IO_METADATAPROPERTIES
TYPE REF TO /AWS1/CL_SGMMETADATAPROPERTIES
/AWS1/CL_SGMMETADATAPROPERTIES
¶
MetadataProperties
IT_TAGS
TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST
TT_TAGLIST
¶
A list of tags to associate with the component. You can use Search API to search on the tags.