You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SageMaker::Types::CreateTrialComponentRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateTrialComponentRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  trial_component_name: "ExperimentEntityName", # required
  display_name: "ExperimentEntityName",
  status: {
    primary_status: "InProgress", # accepts InProgress, Completed, Failed, Stopping, Stopped
    message: "TrialComponentStatusMessage",
  },
  start_time: Time.now,
  end_time: Time.now,
  parameters: {
    "TrialComponentKey256" => {
      string_value: "StringParameterValue",
      number_value: 1.0,
    },
  },
  input_artifacts: {
    "TrialComponentKey64" => {
      media_type: "MediaType",
      value: "TrialComponentArtifactValue", # required
    },
  },
  output_artifacts: {
    "TrialComponentKey64" => {
      media_type: "MediaType",
      value: "TrialComponentArtifactValue", # required
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ String

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

Returns:

  • (String) —

    The name of the component as displayed.

#end_time ⇒ Time

When the component ended.

Returns:

  • (Time) —

    When the component ended.

#input_artifacts ⇒ Hash<String,Types::TrialComponentArtifact>

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

Returns:

#output_artifacts ⇒ Hash<String,Types::TrialComponentArtifact>

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

Returns:

#parameters ⇒ Hash<String,Types::TrialComponentParameterValue>

The hyperparameters for the component.

Returns:

#start_time ⇒ Time

When the component started.

Returns:

  • (Time) —

    When the component started.

#status ⇒ Types::TrialComponentStatus

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

Returns:

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

    A list of tags to associate with the component.

#trial_component_name ⇒ String

The name of the component. The name must be unique in your AWS account and is not case-sensitive.

Returns:

  • (String) —

    The name of the component.