[ aws . sagemaker ]

describe-trial-component

Description

Provides a list of a trials component’s properties.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-trial-component
--trial-component-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--trial-component-name (string)

The name of the trial component to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

TrialComponentName -> (string)

The name of the trial component.

TrialComponentArn -> (string)

The Amazon Resource Name (ARN) of the trial component.

DisplayName -> (string)

The name of the component as displayed. If DisplayName isn’t specified, TrialComponentName is displayed.

Source -> (structure)

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

SourceArn -> (string)

The source ARN.

SourceType -> (string)

The source job type.

Status -> (structure)

The status of the component. States include:

• InProgress

• Completed

• Failed

PrimaryStatus -> (string)

The status of the trial component.

Message -> (string)

If the component failed, a message describing why.

StartTime -> (timestamp)

When the component started.

EndTime -> (timestamp)

When the component ended.

CreationTime -> (timestamp)

When the component was created.

CreatedBy -> (structure)

Who created the component.

UserProfileArn -> (string)

The Amazon Resource Name (ARN) of the user’s profile.

UserProfileName -> (string)

The name of the user’s profile.

DomainId -> (string)

The domain associated with the user.

LastModifiedTime -> (timestamp)

When the component was last modified.

LastModifiedBy -> (structure)

Who last modified the component.

UserProfileArn -> (string)

The Amazon Resource Name (ARN) of the user’s profile.

UserProfileName -> (string)

The name of the user’s profile.

DomainId -> (string)

The domain associated with the user.

Parameters -> (map)

The hyperparameters of the component.

key -> (string)

value -> (structure)

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

StringValue -> (string)

The string value of a categorical hyperparameter. If you specify a value for this parameter, you can’t specify the NumberValue parameter.

NumberValue -> (double)

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can’t specify the StringValue parameter.

InputArtifacts -> (map)

The input artifacts of the component.

key -> (string)

value -> (structure)

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

MediaType -> (string)

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

Value -> (string)

The location of the artifact.

OutputArtifacts -> (map)

The output artifacts of the component.

key -> (string)

value -> (structure)

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

MediaType -> (string)

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

Value -> (string)

The location of the artifact.

Metrics -> (list)

The metrics for the component.

(structure)

A summary of the metrics of a trial component.

MetricName -> (string)

The name of the metric.

SourceArn -> (string)

The Amazon Resource Name (ARN) of the source.

TimeStamp -> (timestamp)

When the metric was last updated.

Max -> (double)

The maximum value of the metric.

Min -> (double)

The minimum value of the metric.

Last -> (double)

The most recent value of the metric.

Count -> (integer)

The number of samples used to generate the metric.

Avg -> (double)

The average value of the metric.

StdDev -> (double)

The standard deviation of the metric.