trials

Creates, updates, deletes, gets or lists a trials resource.

Overview

Name	trials
Type	Resource
Id	aws.sagemaker.trials

Fields

The following fields are returned by SELECT queries:

describe_trial

Name	Datatype	Description
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	When the trial was created.
display_name	string	The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
experiment_name	string	The name of the experiment the trial is part of. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
last_modified_by	object	Information about the user who created or modified a SageMaker resource.
last_modified_time	string (date-time)	When the trial was last modified.
metadata_properties	object	Metadata properties of the tracking entity, trial, or trial component.
source	object	The Amazon Resource Name (ARN) of the source and, optionally, the job type.
trial_arn	string	The Amazon Resource Name (ARN) of the trial. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:experiment-trial/.*</code>)
trial_name	string	The name of the trial. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)

list_trials

Name	Datatype	Description
creation_time	string (date-time)	When the trial was created.
display_name	string	The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
last_modified_time	string (date-time)	When the trial was last modified.
trial_arn	string	The Amazon Resource Name (ARN) of the trial. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:experiment-trial/.*</code>)
trial_name	string	The name of the trial. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
trial_source	object	The source of the trial.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_trial	select	region		Provides a list of a trial's properties.
list_trials	select	region		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.
create_trial	insert	region, TrialName, ExperimentName		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.
update_trial	update	region, TrialName		Updates the display name of a trial.
delete_trial	delete	region		Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_trial

Provides a list of a trial's properties.

SELECT
created_by,
creation_time,
display_name,
experiment_name,
last_modified_by,
last_modified_time,
metadata_properties,
source,
trial_arn,
trial_name
FROM aws.sagemaker.trials
WHERE region = '{{ region }}' -- required
;

list_trials

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.

SELECT
creation_time,
display_name,
last_modified_time,
trial_arn,
trial_name,
trial_source
FROM aws.sagemaker.trials
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_trial

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.

INSERT INTO aws.sagemaker.trials (
TrialName,
DisplayName,
ExperimentName,
MetadataProperties,
Tags,
region
)
SELECT 
'{{ TrialName }}' /* required */,
'{{ DisplayName }}',
'{{ ExperimentName }}' /* required */,
'{{ MetadataProperties }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
trial_arn
;

Manifest

# Description fields are for documentation purposes
- name: trials
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the trials resource.
  - name: TrialName
    value: "{{ TrialName }}"
    description: |
      The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.
  - name: DisplayName
    value: "{{ DisplayName }}"
    description: |
      The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
  - name: ExperimentName
    value: "{{ ExperimentName }}"
    description: |
      The name of the experiment to associate the trial with.
  - name: MetadataProperties
    description: |
      Metadata properties of the tracking entity, trial, or trial component.
    value:
      CommitId: "{{ CommitId }}"
      Repository: "{{ Repository }}"
      GeneratedBy: "{{ GeneratedBy }}"
      ProjectId: "{{ ProjectId }}"
  - name: Tags
    description: |
      A list of tags to associate with the trial. You can use Search API to search on the tags.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_trial

Updates the display name of a trial.

UPDATE aws.sagemaker.trials
SET 
TrialName = '{{ TrialName }}',
DisplayName = '{{ DisplayName }}'
WHERE 
region = '{{ region }}' --required
AND TrialName = '{{ TrialName }}' --required
RETURNING
trial_arn;

DELETE examples

delete_trial

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

DELETE FROM aws.sagemaker.trials
WHERE region = '{{ region }}' --required
;