trial_components

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

Overview

Name	`trial_components`
Type	Resource
Id	`aws.sagemaker.trial_components`

Fields

The following fields are returned by SELECT queries:

describe_trial_component
list_trial_components

Name	Datatype	Description
`created_by`	`object`	Information about the user who created or modified a SageMaker resource.
`creation_time`	`string (date-time)`	When the component was created.
`display_name`	`string`	The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
`end_time`	`string (date-time)`	When the component ended.
`input_artifacts`	`object`	The input artifacts of the component.
`last_modified_by`	`object`	Information about the user who created or modified a SageMaker resource.
`last_modified_time`	`string (date-time)`	When the component was last modified.
`lineage_group_arn`	`string`	The Amazon Resource Name (ARN) of the lineage group. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:lineage-group/.*</code>)
`metadata_properties`	`object`	Metadata properties of the tracking entity, trial, or trial component.
`metrics`	`array`	The metrics for the component.
`output_artifacts`	`object`	The output artifacts of the component.
`parameters`	`object`	The hyperparameters of the component.
`source`	`object`	The Amazon Resource Name (ARN) of the source and, optionally, the job type.
`sources`	`array`	A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
`start_time`	`string (date-time)`	When the component started.
`status`	`object`	The status of the component. States include: InProgress Completed Failed
`trial_component_arn`	`string`	The Amazon Resource Name (ARN) of the trial component. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:experiment-trial-component/.*</code>)
`trial_component_name`	`string`	The name of the trial component. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)

Name	Datatype	Description
`created_by`	`object`	Information about the user who created or modified a SageMaker resource.
`creation_time`	`string (date-time)`	When the component was created.
`display_name`	`string`	The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
`end_time`	`string (date-time)`	When the component ended.
`last_modified_by`	`object`	Information about the user who created or modified a SageMaker resource.
`last_modified_time`	`string (date-time)`	When the component was last modified.
`start_time`	`string (date-time)`	When the component started.
`status`	`object`	The status of the component. States include: InProgress Completed Failed
`trial_component_arn`	`string`	The Amazon Resource Name (ARN) of the trial component. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:experiment-trial-component/.*</code>)
`trial_component_name`	`string`	The name of the trial component. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
`trial_component_source`	`object`	The Amazon Resource Name (ARN) and job type of the source of a trial component.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_trial_component`	`select`	`region`	Provides a list of a trials component's properties.
`list_trial_components`	`select`	`region`	Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following: ExperimentName SourceArn TrialName
`create_trial_component`	`insert`	`region`, `TrialComponentName`	Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials. Trial components include pre-processing jobs, training jobs, and batch transform jobs. 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 component and then use the Search API to search for the tags.
`associate_trial_component`	`update`	`region`, `TrialComponentName`, `TrialName`	Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
`update_trial_component`	`update`	`region`, `TrialComponentName`	Updates one or more properties of a trial component.
`delete_trial_component`	`delete`	`region`	Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
`disassociate_trial_component`	`exec`	`region`, `TrialComponentName`, `TrialName`	Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API. To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

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_component
list_trial_components

Provides a list of a trials component's properties.

SELECT
created_by,
creation_time,
display_name,
end_time,
input_artifacts,
last_modified_by,
last_modified_time,
lineage_group_arn,
metadata_properties,
metrics,
output_artifacts,
parameters,
source,
sources,
start_time,
status,
trial_component_arn,
trial_component_name
FROM aws.sagemaker.trial_components
WHERE region = '{{ region }}' -- required
;

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following: ExperimentName SourceArn TrialName

SELECT
created_by,
creation_time,
display_name,
end_time,
last_modified_by,
last_modified_time,
start_time,
status,
trial_component_arn,
trial_component_name,
trial_component_source
FROM aws.sagemaker.trial_components
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_trial_component
Manifest

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials. Trial components include pre-processing jobs, training jobs, and batch transform jobs. 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 component and then use the Search API to search for the tags.

INSERT INTO aws.sagemaker.trial_components (
TrialComponentName,
DisplayName,
Status,
StartTime,
EndTime,
Parameters,
InputArtifacts,
OutputArtifacts,
MetadataProperties,
Tags,
region
)
SELECT 
'{{ TrialComponentName }}' /* required */,
'{{ DisplayName }}',
'{{ Status }}',
'{{ StartTime }}',
'{{ EndTime }}',
'{{ Parameters }}',
'{{ InputArtifacts }}',
'{{ OutputArtifacts }}',
'{{ MetadataProperties }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
trial_component_arn
;

# Description fields are for documentation purposes
- name: trial_components
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the trial_components resource.
  - name: TrialComponentName
    value: "{{ TrialComponentName }}"
    description: |
      The name of the component. 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 component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
  - name: Status
    description: |
      The status of the component. States include: InProgress Completed Failed
    value:
      PrimaryStatus: "{{ PrimaryStatus }}"
      Message: "{{ Message }}"
  - name: StartTime
    value: "{{ StartTime }}"
    description: |
      When the component started.
  - name: EndTime
    value: "{{ EndTime }}"
    description: |
      When the component ended.
  - name: Parameters
    value: "{{ Parameters }}"
    description: |
      The hyperparameters for the component.
  - name: InputArtifacts
    value: "{{ InputArtifacts }}"
    description: |
      The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
  - name: OutputArtifacts
    value: "{{ OutputArtifacts }}"
    description: |
      The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
  - 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 component. You can use Search API to search on the tags.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

`UPDATE` examples

associate_trial_component
update_trial_component

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

UPDATE aws.sagemaker.trial_components
SET 
TrialComponentName = '{{ TrialComponentName }}',
TrialName = '{{ TrialName }}'
WHERE 
region = '{{ region }}' --required
AND TrialComponentName = '{{ TrialComponentName }}' --required
AND TrialName = '{{ TrialName }}' --required
RETURNING
trial_arn,
trial_component_arn;

Updates one or more properties of a trial component.

UPDATE aws.sagemaker.trial_components
SET 
TrialComponentName = '{{ TrialComponentName }}',
DisplayName = '{{ DisplayName }}',
Status = '{{ Status }}',
StartTime = '{{ StartTime }}',
EndTime = '{{ EndTime }}',
Parameters = '{{ Parameters }}',
ParametersToRemove = '{{ ParametersToRemove }}',
InputArtifacts = '{{ InputArtifacts }}',
InputArtifactsToRemove = '{{ InputArtifactsToRemove }}',
OutputArtifacts = '{{ OutputArtifacts }}',
OutputArtifactsToRemove = '{{ OutputArtifactsToRemove }}'
WHERE 
region = '{{ region }}' --required
AND TrialComponentName = '{{ TrialComponentName }}' --required
RETURNING
trial_component_arn;

`DELETE` examples

delete_trial_component

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

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

Lifecycle Methods

disassociate_trial_component

Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API. To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

EXEC aws.sagemaker.trial_components.disassociate_trial_component 
@region='{{ region }}' --required 
@@json=
'{
"TrialComponentName": "{{ TrialComponentName }}", 
"TrialName": "{{ TrialName }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​