Skip to content

Create Trial

sagemaker_create_trial R Documentation

Creates an SageMaker trial

Description

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 list_trials API. To view a trial's properties, call the describe_trial API. To create a trial component, call the create_trial_component API.

Usage

sagemaker_create_trial(TrialName, DisplayName, ExperimentName,
  MetadataProperties, Tags)

Arguments

TrialName

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

DisplayName

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

ExperimentName

[required] The name of the experiment to associate the trial with.

Tags

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

Value

A list with the following syntax: 

list(
  TrialArn = "string"
)

Request syntax

svc$create_trial(
  TrialName = "string",
  DisplayName = "string",
  ExperimentName = "string",
  MetadataProperties = list(
    CommitId = "string",
    Repository = "string",
    GeneratedBy = "string",
    ProjectId = "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)