Skip to content

Trial

Source code in docs_src/capo_sagemaker/types/trial.py
class Trial(TypedDict, closed=True):
    trial_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the trial.</p>"""
    trial_arn: NotRequired["capo_sagemaker.types.trial_arn.TrialArn"]
    """<p>The Amazon Resource Name (ARN) of the trial.</p>"""
    display_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the trial as displayed. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>"""
    experiment_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the experiment the trial is part of.</p>"""
    source: NotRequired["capo_sagemaker.types.trial_source.TrialSource"]
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the trial was created.</p>"""
    created_by: NotRequired["capo_sagemaker.types.user_context.UserContext"]
    """<p>Who created the trial.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>Who last modified the trial.</p>"""
    last_modified_by: NotRequired["capo_sagemaker.types.user_context.UserContext"]
    metadata_properties: NotRequired[
        "capo_sagemaker.types.metadata_properties.MetadataProperties"
    ]
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>The list of tags that are associated with the trial. 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>"""
    trial_component_summaries: NotRequired[
        "capo_sagemaker.types.trial_component_simple_summaries.TrialComponentSimpleSummaries"
    ]
    """<p>A list of the components associated with the trial. For each component, a summary of the component's properties is included.</p>"""

created_by instance-attribute

created_by: NotRequired[UserContext]

Who created the trial.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

When the trial was created.

display_name instance-attribute

display_name: NotRequired[ExperimentEntityName]

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

experiment_name instance-attribute

experiment_name: NotRequired[ExperimentEntityName]

The name of the experiment the trial is part of.

last_modified_by instance-attribute

last_modified_by: NotRequired[UserContext]

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

Who last modified the trial.

metadata_properties instance-attribute

metadata_properties: NotRequired[MetadataProperties]

source instance-attribute

source: NotRequired[TrialSource]

tags instance-attribute

tags: NotRequired[TagList]

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

trial_arn instance-attribute

trial_arn: NotRequired[TrialArn]

The Amazon Resource Name (ARN) of the trial.

trial_component_summaries instance-attribute

trial_component_summaries: NotRequired[TrialComponentSimpleSummaries]

A list of the components associated with the trial. For each component, a summary of the component's properties is included.

trial_name instance-attribute

trial_name: NotRequired[ExperimentEntityName]

The name of the trial.