software.amazon.awssdk.services.sagemaker.model

Class CreateHyperParameterTuningJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateHyperParameterTuningJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateHyperParameterTuningJobRequest.Builder,CreateHyperParameterTuningJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateHyperParameterTuningJobRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateHyperParameterTuningJobRequest.Builder,CreateHyperParameterTuningJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateHyperParameterTuningJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateHyperParameterTuningJobRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTrainingJobDefinitions() Returns true if the TrainingJobDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
HyperParameterTuningJobConfig	hyperParameterTuningJobConfig() The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job.
String	hyperParameterTuningJobName() The name of the tuning job.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateHyperParameterTuningJobRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() An array of key-value pairs.
CreateHyperParameterTuningJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
HyperParameterTrainingJobDefinition	trainingJobDefinition() The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.
List<HyperParameterTrainingJobDefinition>	trainingJobDefinitions() A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
HyperParameterTuningJobWarmStartConfig	warmStartConfig() Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hyperParameterTuningJobName

public final String hyperParameterTuningJobName()

The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

Returns:

The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

hyperParameterTuningJobConfig

public final HyperParameterTuningJobConfig hyperParameterTuningJobConfig()

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

Returns:

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

trainingJobDefinition

public final HyperParameterTrainingJobDefinition trainingJobDefinition()

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

Returns:

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

hasTrainingJobDefinitions

public final boolean hasTrainingJobDefinitions()

Returns true if the TrainingJobDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

trainingJobDefinitions

public final List<HyperParameterTrainingJobDefinition> trainingJobDefinitions()

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

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

You can use hasTrainingJobDefinitions() to see if a value was sent in this field.

Returns:

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

warmStartConfig

public final HyperParameterTuningJobWarmStartConfig warmStartConfig()

Specifies the configuration for starting the hyperparameter 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.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job 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.

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.

Returns:

Specifies the configuration for starting the hyperparameter 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.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job 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.

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.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

toBuilder

public CreateHyperParameterTuningJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateHyperParameterTuningJobRequest.Builder,CreateHyperParameterTuningJobRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateHyperParameterTuningJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo