Amazon SageMaker
Developer Guide

DescribeHyperParameterTuningJob

Gets a description of a hyperparameter tuning job.

Request Syntax

{ "HyperParameterTuningJobName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

HyperParameterTuningJobName

The name of the tuning job to describe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

Response Syntax

{ "BestTrainingJob": { "CreationTime": number, "FailureReason": "string", "FinalHyperParameterTuningJobObjectiveMetric": { "MetricName": "string", "Type": "string", "Value": number }, "ObjectiveStatus": "string", "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TunedHyperParameters": { "string" : "string" } }, "CreationTime": number, "FailureReason": "string", "HyperParameterTuningEndTime": number, "HyperParameterTuningJobArn": "string", "HyperParameterTuningJobConfig": { "HyperParameterTuningJobObjective": { "MetricName": "string", "Type": "string" }, "ParameterRanges": { "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string" } ] }, "ResourceLimits": { "MaxNumberOfTrainingJobs": number, "MaxParallelTrainingJobs": number }, "Strategy": "string" }, "HyperParameterTuningJobName": "string", "HyperParameterTuningJobStatus": "string", "LastModifiedTime": number, "ObjectiveStatusCounters": { "Failed": number, "Pending": number, "Succeeded": number }, "TrainingJobDefinition": { "AlgorithmSpecification": { "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingInputMode": "string" }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string" } ], "OutputDataConfig": { "KmsKeyId": "string", "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RoleArn": "string", "StaticHyperParameters": { "string" : "string" }, "StoppingCondition": { "MaxRuntimeInSeconds": number }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "TrainingJobStatusCounters": { "Completed": number, "InProgress": number, "NonRetryableError": number, "RetryableError": number, "Stopped": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BestTrainingJob

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

Type: HyperParameterTrainingJobSummary object

CreationTime

The date and time that the tuning job started.

Type: Timestamp

FailureReason

If the tuning job failed, the reason it failed.

Type: String

Length Constraints: Maximum length of 1024.

HyperParameterTuningEndTime

The date and time that the tuning job ended.

Type: Timestamp

HyperParameterTuningJobArn

The Amazon Resource Name (ARN) of the tuning job.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*

HyperParameterTuningJobConfig

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

Type: HyperParameterTuningJobConfig object

HyperParameterTuningJobName

The name of the tuning job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

HyperParameterTuningJobStatus

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

Type: String

Valid Values: Completed | InProgress | Failed | Stopped | Stopping

LastModifiedTime

The date and time that the status of the tuning job was modified.

Type: Timestamp

ObjectiveStatusCounters

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

Type: ObjectiveStatusCounters object

TrainingJobDefinition

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

Type: HyperParameterTrainingJobDefinition object

TrainingJobStatusCounters

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

Type: TrainingJobStatusCounters object

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: