HyperParameterTuningJobSearchEntity - Amazon SageMaker

HyperParameterTuningJobSearchEntity

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

Contents

BestTrainingJob

The container for the summary information about a training job.

Type: HyperParameterTrainingJobSummary object

Required: No

ConsumedResources

The total amount of resources consumed by a hyperparameter tuning job.

Type: HyperParameterTuningJobConsumedResources object

Required: No

CreationTime

The time that a hyperparameter tuning job was created.

Type: Timestamp

Required: No

FailureReason

The error that was created when a hyperparameter tuning job failed.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

HyperParameterTuningEndTime

The time that a hyperparameter tuning job ended.

Type: Timestamp

Required: No

HyperParameterTuningJobArn

The Amazon Resource Name (ARN) of a hyperparameter 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/.*

Required: No

HyperParameterTuningJobConfig

Configures a hyperparameter tuning job.

Type: HyperParameterTuningJobConfig object

Required: No

HyperParameterTuningJobName

The name of a 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}

Required: No

HyperParameterTuningJobStatus

The status of a hyperparameter tuning job.

Type: String

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

Required: No

LastModifiedTime

The time that a hyperparameter tuning job was last modified.

Type: Timestamp

Required: No

ObjectiveStatusCounters

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

Type: ObjectiveStatusCounters object

Required: No

OverallBestTrainingJob

The container for the summary information about a training job.

Type: HyperParameterTrainingJobSummary object

Required: No

Tags

The tags associated with a hyperparameter tuning job. For more information see Tagging AWS resources.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

TrainingJobDefinition

Defines the training jobs launched by a hyperparameter tuning job.

Type: HyperParameterTrainingJobDefinition object

Required: No

TrainingJobDefinitions

The job definitions included in a hyperparameter tuning job.

Type: Array of HyperParameterTrainingJobDefinition objects

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

Required: No

TrainingJobStatusCounters

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

Type: TrainingJobStatusCounters object

Required: No

TuningJobCompletionDetails

Information about either a current or completed hyperparameter tuning job.

Type: HyperParameterTuningJobCompletionDetails object

Required: No

WarmStartConfig

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter 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.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

Note

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

Type: HyperParameterTuningJobWarmStartConfig object

Required: No

See Also

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