TrialComponent - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

TrialComponent

The properties of a trial component as returned by the Search API.

Contents

CreatedBy

Who created the trial component.

Type: UserContext object

Required: No

CreationTime

When the component was created.

Type: Timestamp

Required: No

DisplayName

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 120.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}

Required: No

EndTime

When the component ended.

Type: Timestamp

Required: No

InputArtifacts

The input artifacts of the component.

Type: String to TrialComponentArtifact object map

Map Entries: Maximum number of 30 items.

Key Length Constraints: Maximum length of 64.

Key Pattern: .*

Required: No

LastModifiedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Type: UserContext object

Required: No

LastModifiedTime

When the component was last modified.

Type: Timestamp

Required: No

LineageGroupArn

The Amazon Resource Name (ARN) of the lineage group resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.*

Required: No

MetadataProperties

Metadata properties of the tracking entity, trial, or trial component.

Type: MetadataProperties object

Required: No

Metrics

The metrics for the component.

Type: Array of TrialComponentMetricSummary objects

Required: No

OutputArtifacts

The output artifacts of the component.

Type: String to TrialComponentArtifact object map

Map Entries: Maximum number of 30 items.

Key Length Constraints: Maximum length of 64.

Key Pattern: .*

Required: No

Parameters

The hyperparameters of the component.

Type: String to TrialComponentParameterValue object map

Map Entries: Maximum number of 150 items.

Key Length Constraints: Maximum length of 256.

Key Pattern: .*

Required: No

Parents

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

Type: Array of Parent objects

Required: No

Source

The Amazon Resource Name (ARN) and job type of the source of the component.

Type: TrialComponentSource object

Required: No

SourceDetail

Details of the source of the component.

Type: TrialComponentSourceDetail object

Required: No

StartTime

When the component started.

Type: Timestamp

Required: No

Status

The status of the trial component.

Type: TrialComponentStatus object

Required: No

Tags

The list of tags that are associated with the component. You can use Search API to search on the tags.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

TrialComponentArn

The Amazon Resource Name (ARN) of the trial component.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial-component/.*

Required: No

TrialComponentName

The name of the trial component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 120.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: