DescribeHyperParameterTuningJob - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeHyperParameterTuningJob

Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.

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.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}

Required: Yes

Response Syntax

{ "Autotune": { "Mode": "string" }, "BestTrainingJob": { "CreationTime": number, "FailureReason": "string", "FinalHyperParameterTuningJobObjectiveMetric": { "MetricName": "string", "Type": "string", "Value": number }, "ObjectiveStatus": "string", "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobDefinitionName": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TunedHyperParameters": { "string" : "string" }, "TuningJobName": "string" }, "ConsumedResources": { "RuntimeInSeconds": number }, "CreationTime": number, "FailureReason": "string", "HyperParameterTuningEndTime": number, "HyperParameterTuningJobArn": "string", "HyperParameterTuningJobConfig": { "HyperParameterTuningJobObjective": { "MetricName": "string", "Type": "string" }, "ParameterRanges": { "AutoParameters": [ { "Name": "string", "ValueHint": "string" } ], "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ] }, "RandomSeed": number, "ResourceLimits": { "MaxNumberOfTrainingJobs": number, "MaxParallelTrainingJobs": number, "MaxRuntimeInSeconds": number }, "Strategy": "string", "StrategyConfig": { "HyperbandStrategyConfig": { "MaxResource": number, "MinResource": number } }, "TrainingJobEarlyStoppingType": "string", "TuningJobCompletionCriteria": { "BestObjectiveNotImproving": { "MaxNumberOfTrainingJobsNotImproving": number }, "ConvergenceDetected": { "CompleteOnConvergence": "string" }, "TargetObjectiveMetricValue": number } }, "HyperParameterTuningJobName": "string", "HyperParameterTuningJobStatus": "string", "LastModifiedTime": number, "ObjectiveStatusCounters": { "Failed": number, "Pending": number, "Succeeded": number }, "OverallBestTrainingJob": { "CreationTime": number, "FailureReason": "string", "FinalHyperParameterTuningJobObjectiveMetric": { "MetricName": "string", "Type": "string", "Value": number }, "ObjectiveStatus": "string", "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobDefinitionName": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TunedHyperParameters": { "string" : "string" }, "TuningJobName": "string" }, "TrainingJobDefinition": { "AlgorithmSpecification": { "AlgorithmName": "string", "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingInputMode": "string" }, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "DefinitionName": "string", "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "HyperParameterRanges": { "AutoParameters": [ { "Name": "string", "ValueHint": "string" } ], "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ] }, "HyperParameterTuningResourceConfig": { "AllocationStrategy": "string", "InstanceConfigs": [ { "InstanceCount": number, "InstanceType": "string", "VolumeSizeInGB": number } ], "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "InstanceGroupNames": [ "string" ], "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "StaticHyperParameters": { "string" : "string" }, "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "TuningObjective": { "MetricName": "string", "Type": "string" }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "TrainingJobDefinitions": [ { "AlgorithmSpecification": { "AlgorithmName": "string", "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingInputMode": "string" }, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "DefinitionName": "string", "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "HyperParameterRanges": { "AutoParameters": [ { "Name": "string", "ValueHint": "string" } ], "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ] }, "HyperParameterTuningResourceConfig": { "AllocationStrategy": "string", "InstanceConfigs": [ { "InstanceCount": number, "InstanceType": "string", "VolumeSizeInGB": number } ], "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "InstanceGroupNames": [ "string" ], "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "StaticHyperParameters": { "string" : "string" }, "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "TuningObjective": { "MetricName": "string", "Type": "string" }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ], "TrainingJobStatusCounters": { "Completed": number, "InProgress": number, "NonRetryableError": number, "RetryableError": number, "Stopped": number }, "TuningJobCompletionDetails": { "ConvergenceDetectedTime": number, "NumberOfTrainingJobsObjectiveNotImproving": number }, "WarmStartConfig": { "ParentHyperParameterTuningJobs": [ { "HyperParameterTuningJobName": "string" } ], "WarmStartType": "string" } }

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.

Autotune

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

Type: Autotune object

BestTrainingJob

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

Type: HyperParameterTrainingJobSummary object

ConsumedResources

The total resources consumed by your hyperparameter tuning job.

Type: HyperParameterTuningJobConsumedResources 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 hyperparameter tuning job.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}

HyperParameterTuningJobStatus

The status of the tuning job.

Type: String

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

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

OverallBestTrainingJob

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

Type: HyperParameterTrainingJobSummary object

TrainingJobDefinition

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

Type: HyperParameterTrainingJobDefinition object

TrainingJobDefinitions

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

Type: Array of HyperParameterTrainingJobDefinition objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

TrainingJobStatusCounters

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

Type: TrainingJobStatusCounters object

TuningJobCompletionDetails

Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

Type: HyperParameterTuningJobCompletionDetails object

WarmStartConfig

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

Type: HyperParameterTuningJobWarmStartConfig 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 Amazon SDKs, see the following: