Class: Aws::SageMaker::Types::Trial

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::Trial

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

The properties of a trial as returned by the [Search] API.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_by ⇒ Types::UserContext

  Who created the trial.

• #creation_time ⇒ Time

  When the trial was created.

• #display_name ⇒ String

  The name of the trial as displayed.

• #experiment_name ⇒ String

  The name of the experiment the trial is part of.

• #last_modified_by ⇒ Types::UserContext

  Information about the user who created or modified a SageMaker resource.

• #last_modified_time ⇒ Time

  Who last modified the trial.

• #metadata_properties ⇒ Types::MetadataProperties

  Metadata properties of the tracking entity, trial, or trial component.

• #source ⇒ Types::TrialSource

  The source of the trial.

• #tags ⇒ Array<Types::Tag>

  The list of tags that are associated with the trial.

• #trial_arn ⇒ String

  The Amazon Resource Name (ARN) of the trial.

• #trial_component_summaries ⇒ Array<Types::TrialComponentSimpleSummary>

  A list of the components associated with the trial.

• #trial_name ⇒ String

  The name of the trial.

Instance Attribute Details

#created_by ⇒ Types::UserContext

Who created the trial.

Returns:

• (Types::UserContext)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

When the trial was created.

Returns:

• (Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The name of the trial as displayed. If ‘DisplayName` isn’t specified, ‘TrialName` is displayed.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_name ⇒ String

The name of the experiment the trial is part of.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_by ⇒ Types::UserContext

Information about the user who created or modified a SageMaker resource.

Returns:

• (Types::UserContext)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

Who last modified the trial.

Returns:

• (Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_properties ⇒ Types::MetadataProperties

Metadata properties of the tracking entity, trial, or trial component.

Returns:

• (Types::MetadataProperties)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::TrialSource

The source of the trial.

Returns:

• (Types::TrialSource)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The list of tags that are associated with the trial. You can use

Search][1

API to search on the tags.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#trial_arn ⇒ String

The Amazon Resource Name (ARN) of the trial.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#trial_component_summaries ⇒ Array<Types::TrialComponentSimpleSummary>

A list of the components associated with the trial. For each component, a summary of the component’s properties is included.

Returns:

• (Array<Types::TrialComponentSimpleSummary>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#trial_name ⇒ String

The name of the trial.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 48091

class Trial < Struct.new(
  :trial_name,
  :trial_arn,
  :display_name,
  :experiment_name,
  :source,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :metadata_properties,
  :tags,
  :trial_component_summaries)
  SENSITIVE = []
  include Aws::Structure
end