create_trial

SageMaker.Client.create_trial(**kwargs)

Creates an SageMaker trial . A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment .

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 and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

See also: AWS API Documentation

Request Syntax

response = client.create_trial(
    TrialName='string',
    DisplayName='string',
    ExperimentName='string',
    MetadataProperties={
        'CommitId': 'string',
        'Repository': 'string',
        'GeneratedBy': 'string',
        'ProjectId': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

• TrialName (string) --

  [REQUIRED]

  The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

• DisplayName (string) -- The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
• ExperimentName (string) --

  [REQUIRED]

  The name of the experiment to associate the trial with.

• MetadataProperties (dict) --

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

  • CommitId (string) --

    The commit ID.

  • Repository (string) --

    The repository.

  • GeneratedBy (string) --

    The entity this entity was generated by.

  • ProjectId (string) --

    The project ID.

• Tags (list) --

  A list of tags to associate with the trial. You can use Search API to search on the tags.

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) -- [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) -- [REQUIRED]

      The tag value.

Return type

dict

Returns

Response Syntax

{
    'TrialArn': 'string'
}

Response Structure

• (dict) --

  • TrialArn (string) --

    The Amazon Resource Name (ARN) of the trial.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound
• SageMaker.Client.exceptions.ResourceLimitExceeded