experiments

Creates, updates, deletes, gets or lists an experiments resource.

Overview

Name	experiments
Type	Resource
Id	aws.sagemaker.experiments

Fields

The following fields are returned by SELECT queries:

describe_experiment

Name	Datatype	Description
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	When the experiment was created.
description	string	The description of the experiment. (pattern: <code>.*</code>)
display_name	string	The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
experiment_arn	string	The Amazon Resource Name (ARN) of the experiment. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:experiment/.*</code>)
experiment_name	string	The name of the experiment. (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 experiment was last modified.
source	object	The Amazon Resource Name (ARN) of the source and, optionally, the type.

list_experiments

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_experiment	select	region		Provides a list of an experiment's properties.
list_experiments	select	region		Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.
create_experiment	insert	region, ExperimentName		Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model. In the Studio UI, trials are referred to as run groups and trial components are referred to as runs. The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant. 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 experiments, trials, trial components and then use the Search API to search for the tags. To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API. To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
update_experiment	update	region, ExperimentName		Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
delete_experiment	delete	region		Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

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_experiment

Provides a list of an experiment's properties.

SELECT
created_by,
creation_time,
description,
display_name,
experiment_arn,
experiment_name,
last_modified_by,
last_modified_time,
source
FROM aws.sagemaker.experiments
WHERE region = '{{ region }}' -- required
;

list_experiments

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

SELECT
creation_time,
display_name,
experiment_arn,
experiment_name,
experiment_source,
last_modified_time
FROM aws.sagemaker.experiments
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_experiment

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model. In the Studio UI, trials are referred to as run groups and trial components are referred to as runs. The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant. 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 experiments, trials, trial components and then use the Search API to search for the tags. To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API. To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

INSERT INTO aws.sagemaker.experiments (
ExperimentName,
DisplayName,
Description,
Tags,
region
)
SELECT 
'{{ ExperimentName }}' /* required */,
'{{ DisplayName }}',
'{{ Description }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
experiment_arn
;

Manifest

# Description fields are for documentation purposes
- name: experiments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the experiments resource.
  - name: ExperimentName
    value: "{{ ExperimentName }}"
    description: |
      The name of the experiment. 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 experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the experiment.
  - name: Tags
    description: |
      A list of tags to associate with the experiment. You can use Search API to search on the tags.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_experiment

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

UPDATE aws.sagemaker.experiments
SET 
ExperimentName = '{{ ExperimentName }}',
DisplayName = '{{ DisplayName }}',
Description = '{{ Description }}'
WHERE 
region = '{{ region }}' --required
AND ExperimentName = '{{ ExperimentName }}' --required
RETURNING
experiment_arn;

DELETE examples

delete_experiment

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

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