software.amazon.awssdk.services.sagemaker.model

Class HyperParameterTrainingJobDefinition

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.HyperParameterTrainingJobDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HyperParameterTrainingJobDefinition.Builder,HyperParameterTrainingJobDefinition>

@Generated(value="software.amazon.awssdk:codegen")
public final class HyperParameterTrainingJobDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HyperParameterTrainingJobDefinition.Builder,HyperParameterTrainingJobDefinition>

Defines the training jobs launched by a hyperparameter tuning job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HyperParameterTrainingJobDefinition.Builder

Method Summary

Modifier and Type	Method and Description
HyperParameterAlgorithmSpecification	algorithmSpecification() The HyperParameterAlgorithmSpecification object that specifies the algorithm to use for the training jobs that the tuning job launches.
static HyperParameterTrainingJobDefinition.Builder	builder()
Boolean	enableNetworkIsolation() Isolates the training container.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<Channel>	inputDataConfig() An array of Channel objects that specify the input for the training jobs that the tuning job launches.
OutputDataConfig	outputDataConfig() Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
ResourceConfig	resourceConfig() The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.
String	roleArn() The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
List<SdkField<?>>	sdkFields()
static Class<? extends HyperParameterTrainingJobDefinition.Builder>	serializableBuilderClass()
Map<String,String>	staticHyperParameters() Specifies the values of hyperparameters that do not change for the tuning job.
StoppingCondition	stoppingCondition() Sets a maximum duration for the training jobs that the tuning job launches.
HyperParameterTrainingJobDefinition.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
VpcConfig	vpcConfig() The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

staticHyperParameters

public Map<String,String> staticHyperParameters()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

algorithmSpecification

public HyperParameterAlgorithmSpecification algorithmSpecification()

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

Returns:

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

roleArn

public String roleArn()

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

Returns:

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

inputDataConfig

public List<Channel> inputDataConfig()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

vpcConfig

public VpcConfig 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.

Returns:

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.

outputDataConfig

public OutputDataConfig outputDataConfig()

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

Returns:

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

resourceConfig

public ResourceConfig 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 Amazon 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.

Returns:

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 Amazon 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.

stoppingCondition

public StoppingCondition stoppingCondition()

Sets a maximum duration for the training jobs that the tuning job launches. Use this parameter to limit model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts.

When Amazon SageMaker terminates a job because the stopping condition has been met, training algorithms provided by Amazon SageMaker save the intermediate results of the job.

Returns:

Sets a maximum duration for the training jobs that the tuning job launches. Use this parameter to limit model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts.

When Amazon SageMaker terminates a job because the stopping condition has been met, training algorithms provided by Amazon SageMaker save the intermediate results of the job.

enableNetworkIsolation

public Boolean 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, Amazon SageMaker downloads and uploads customer data and model artifacts through the specifed VPC, but the training container does not have network access.

The Semantic Segmentation built-in algorithm does not support network isolation.

Returns:

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, Amazon SageMaker downloads and uploads customer data and model artifacts through the specifed VPC, but the training container does not have network access.

The Semantic Segmentation built-in algorithm does not support network isolation.

toBuilder

public HyperParameterTrainingJobDefinition.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<HyperParameterTrainingJobDefinition.Builder,HyperParameterTrainingJobDefinition>

Returns:

a builder for type T

builder

public static HyperParameterTrainingJobDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends HyperParameterTrainingJobDefinition.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.