Documentation

Defines the training jobs launched by a hyperparameter tuning job.

See: newHyperParameterTrainingJobDefinition smart constructor.

Create a value of HyperParameterTrainingJobDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:checkpointConfig:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_checkpointConfig - Undocumented member.

$sel:definitionName:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_definitionName - The job definition name.

$sel:enableInterContainerTrafficEncryption:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_enableInterContainerTrafficEncryption - To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

$sel:enableManagedSpotTraining:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_enableManagedSpotTraining - A Boolean indicating whether managed spot training is enabled (True) or not (False).

$sel:enableNetworkIsolation:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_enableNetworkIsolation - Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

$sel:hyperParameterRanges:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_hyperParameterRanges - Undocumented member.

$sel:hyperParameterTuningResourceConfig:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_hyperParameterTuningResourceConfig - The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

$sel:inputDataConfig:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_inputDataConfig - An array of Channel objects that specify the input for the training jobs that the tuning job launches.

$sel:resourceConfig:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_resourceConfig - The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

$sel:retryStrategy:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_retryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

$sel:staticHyperParameters:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_staticHyperParameters - Specifies the values of hyperparameters that do not change for the tuning job.

$sel:tuningObjective:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_tuningObjective - Undocumented member.

$sel:vpcConfig:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_vpcConfig - The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

$sel:algorithmSpecification:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_algorithmSpecification - The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

$sel:roleArn:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

$sel:outputDataConfig:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_outputDataConfig - Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

$sel:stoppingCondition:HyperParameterTrainingJobDefinition', hyperParameterTrainingJobDefinition_stoppingCondition - Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

Undocumented member.

The job definition name.

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

A Boolean indicating whether managed spot training is enabled (True) or not (False).

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

Undocumented member.

The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

The number of times to retry the job when the job fails due to an InternalServerError.

Specifies the values of hyperparameters that do not change for the tuning job.

Undocumented member.

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.