[ aws . sagemaker ]

create-trial

Description

Creates an Amazon 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 Amazon SageMaker experiment .

When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS 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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-trial
--trial-name <value>
[--display-name <value>]
--experiment-name <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--trial-name (string)

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

--display-name (string)

The name of the trial as displayed. The name doesn’t need to be unique. If DisplayName isn’t specified, TrialName is displayed.

--experiment-name (string)

The name of the experiment to associate the trial with.

--tags (list)

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

(structure)

Describes a tag.

Key -> (string)

The tag key.

Value -> (string)

The tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

TrialArn -> (string)

The Amazon Resource Name (ARN) of the trial.