Skip to content

TrialComponent

Source code in docs_src/capo_sagemaker/types/trial_component.py
class TrialComponent(TypedDict, closed=True):
    trial_component_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the trial component.</p>"""
    display_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the component as displayed. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>"""
    trial_component_arn: NotRequired[
        "capo_sagemaker.types.trial_component_arn.TrialComponentArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the trial component.</p>"""
    source: NotRequired[
        "capo_sagemaker.types.trial_component_source.TrialComponentSource"
    ]
    """<p>The Amazon Resource Name (ARN) and job type of the source of the component.</p>"""
    status: NotRequired[
        "capo_sagemaker.types.trial_component_status.TrialComponentStatus"
    ]
    start_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the component started.</p>"""
    end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the component ended.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the component was created.</p>"""
    created_by: NotRequired["capo_sagemaker.types.user_context.UserContext"]
    """<p>Who created the trial component.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the component was last modified.</p>"""
    last_modified_by: NotRequired["capo_sagemaker.types.user_context.UserContext"]
    parameters: NotRequired[
        "capo_sagemaker.types.trial_component_parameters.TrialComponentParameters"
    ]
    """<p>The hyperparameters of the component.</p>"""
    input_artifacts: NotRequired[
        "capo_sagemaker.types.trial_component_artifacts.TrialComponentArtifacts"
    ]
    """<p>The input artifacts of the component.</p>"""
    output_artifacts: NotRequired[
        "capo_sagemaker.types.trial_component_artifacts.TrialComponentArtifacts"
    ]
    """<p>The output artifacts of the component.</p>"""
    metrics: NotRequired[
        "capo_sagemaker.types.trial_component_metric_summaries.TrialComponentMetricSummaries"
    ]
    """<p>The metrics for the component.</p>"""
    metadata_properties: NotRequired[
        "capo_sagemaker.types.metadata_properties.MetadataProperties"
    ]
    source_detail: NotRequired[
        "capo_sagemaker.types.trial_component_source_detail.TrialComponentSourceDetail"
    ]
    """<p>Details of the source of the component.</p>"""
    lineage_group_arn: NotRequired[
        "capo_sagemaker.types.lineage_group_arn.LineageGroupArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the lineage group resource.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>The list of tags that are associated with the component. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>"""
    parents: NotRequired["capo_sagemaker.types.parents.Parents"]
    """<p>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.</p>"""
    run_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the experiment run.</p>"""

created_by instance-attribute

created_by: NotRequired[UserContext]

Who created the trial component.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

When the component was created.

display_name instance-attribute

display_name: NotRequired[ExperimentEntityName]

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

end_time instance-attribute

end_time: NotRequired[Timestamp]

When the component ended.

input_artifacts instance-attribute

input_artifacts: NotRequired[TrialComponentArtifacts]

The input artifacts of the component.

last_modified_by instance-attribute

last_modified_by: NotRequired[UserContext]

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

When the component was last modified.

lineage_group_arn instance-attribute

lineage_group_arn: NotRequired[LineageGroupArn]

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

metadata_properties instance-attribute

metadata_properties: NotRequired[MetadataProperties]

metrics instance-attribute

metrics: NotRequired[TrialComponentMetricSummaries]

The metrics for the component.

output_artifacts instance-attribute

output_artifacts: NotRequired[TrialComponentArtifacts]

The output artifacts of the component.

parameters instance-attribute

parameters: NotRequired[TrialComponentParameters]

The hyperparameters of the component.

parents instance-attribute

parents: NotRequired[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.

run_name instance-attribute

run_name: NotRequired[ExperimentEntityName]

The name of the experiment run.

source instance-attribute

source: NotRequired[TrialComponentSource]

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

source_detail instance-attribute

source_detail: NotRequired[TrialComponentSourceDetail]

Details of the source of the component.

start_time instance-attribute

start_time: NotRequired[Timestamp]

When the component started.

status instance-attribute

status: NotRequired[TrialComponentStatus]

tags instance-attribute

tags: NotRequired[TagList]

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

trial_component_arn instance-attribute

trial_component_arn: NotRequired[TrialComponentArn]

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

trial_component_name instance-attribute

trial_component_name: NotRequired[ExperimentEntityName]

The name of the trial component.