SageMaker / Client / list_trials

list_trials#

SageMaker.Client.list_trials(**kwargs)#

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

See also: AWS API Documentation

Request Syntax

response = client.list_trials(
    ExperimentName='string',
    TrialComponentName='string',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ExperimentName (string) – A filter that returns only trials that are part of the specified experiment.

  • TrialComponentName (string) – A filter that returns only trials that are associated with the specified trial component.

  • CreatedAfter (datetime) – A filter that returns only trials created after the specified time.

  • CreatedBefore (datetime) – A filter that returns only trials created before the specified time.

  • SortBy (string) – The property used to sort results. The default value is CreationTime.

  • SortOrder (string) – The sort order. The default value is Descending.

  • MaxResults (integer) – The maximum number of trials to return in the response. The default value is 10.

  • NextToken (string) – If the previous call to ListTrials didn’t return the full set of trials, the call returns a token for getting the next set of trials.

Return type:

dict

Returns:

Response Syntax

{
    'TrialSummaries': [
        {
            'TrialArn': 'string',
            'TrialName': 'string',
            'DisplayName': 'string',
            'TrialSource': {
                'SourceArn': 'string',
                'SourceType': 'string'
            },
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TrialSummaries (list) –

      A list of the summaries of your trials.

      • (dict) –

        A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

        • TrialArn (string) –

          The Amazon Resource Name (ARN) of the trial.

        • TrialName (string) –

          The name of the trial.

        • DisplayName (string) –

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

        • TrialSource (dict) –

          The source of the trial.

          • SourceArn (string) –

            The Amazon Resource Name (ARN) of the source.

          • SourceType (string) –

            The source job type.

        • CreationTime (datetime) –

          When the trial was created.

        • LastModifiedTime (datetime) –

          When the trial was last modified.

    • NextToken (string) –

      A token for getting the next set of trials, if there are any.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound