@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateHyperParameterTuningJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateHyperParameterTuningJobRequest() |
Modifier and Type | Method and Description |
---|---|
CreateHyperParameterTuningJobRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Autotune |
getAutotune()
Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following
fields:
|
HyperParameterTuningJobConfig |
getHyperParameterTuningJobConfig()
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 |
getHyperParameterTuningJobName()
The name of the tuning job.
|
List<Tag> |
getTags()
An array of key-value pairs.
|
HyperParameterTrainingJobDefinition |
getTrainingJobDefinition()
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> |
getTrainingJobDefinitions()
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
|
HyperParameterTuningJobWarmStartConfig |
getWarmStartConfig()
Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as
a starting point.
|
int |
hashCode() |
void |
setAutotune(Autotune autotune)
Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following
fields:
|
void |
setHyperParameterTuningJobConfig(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.
|
void |
setHyperParameterTuningJobName(String hyperParameterTuningJobName)
The name of the tuning job.
|
void |
setTags(Collection<Tag> tags)
An array of key-value pairs.
|
void |
setTrainingJobDefinition(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.
|
void |
setTrainingJobDefinitions(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions)
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
|
void |
setWarmStartConfig(HyperParameterTuningJobWarmStartConfig warmStartConfig)
Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as
a starting point.
|
String |
toString()
Returns a string representation of this object.
|
CreateHyperParameterTuningJobRequest |
withAutotune(Autotune autotune)
Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following
fields:
|
CreateHyperParameterTuningJobRequest |
withHyperParameterTuningJobConfig(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.
|
CreateHyperParameterTuningJobRequest |
withHyperParameterTuningJobName(String hyperParameterTuningJobName)
The name of the tuning job.
|
CreateHyperParameterTuningJobRequest |
withTags(Collection<Tag> tags)
An array of key-value pairs.
|
CreateHyperParameterTuningJobRequest |
withTags(Tag... tags)
An array of key-value pairs.
|
CreateHyperParameterTuningJobRequest |
withTrainingJobDefinition(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.
|
CreateHyperParameterTuningJobRequest |
withTrainingJobDefinitions(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions)
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
|
CreateHyperParameterTuningJobRequest |
withTrainingJobDefinitions(HyperParameterTrainingJobDefinition... trainingJobDefinitions)
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
|
CreateHyperParameterTuningJobRequest |
withWarmStartConfig(HyperParameterTuningJobWarmStartConfig warmStartConfig)
Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as
a starting point.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public CreateHyperParameterTuningJobRequest()
public void setHyperParameterTuningJobName(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 Amazon Web Services account and Amazon Web Services 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.
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 Amazon Web Services account and Amazon Web Services
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.public String getHyperParameterTuningJobName()
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 Amazon Web Services account and Amazon Web Services 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.
public CreateHyperParameterTuningJobRequest withHyperParameterTuningJobName(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 Amazon Web Services account and Amazon Web Services 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.
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 Amazon Web Services account and Amazon Web Services
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.public void setHyperParameterTuningJobConfig(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.
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.public HyperParameterTuningJobConfig getHyperParameterTuningJobConfig()
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.
public CreateHyperParameterTuningJobRequest withHyperParameterTuningJobConfig(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.
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.public void setTrainingJobDefinition(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.
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.public HyperParameterTrainingJobDefinition getTrainingJobDefinition()
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.
public CreateHyperParameterTuningJobRequest withTrainingJobDefinition(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.
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.public List<HyperParameterTrainingJobDefinition> getTrainingJobDefinitions()
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
public void setTrainingJobDefinitions(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions)
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
trainingJobDefinitions
- A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.public CreateHyperParameterTuningJobRequest withTrainingJobDefinitions(HyperParameterTrainingJobDefinition... trainingJobDefinitions)
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
NOTE: This method appends the values to the existing list (if any). Use
setTrainingJobDefinitions(java.util.Collection)
or
withTrainingJobDefinitions(java.util.Collection)
if you want to override the existing values.
trainingJobDefinitions
- A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.public CreateHyperParameterTuningJobRequest withTrainingJobDefinitions(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions)
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
trainingJobDefinitions
- A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.public void setWarmStartConfig(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.
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.
public HyperParameterTuningJobWarmStartConfig getWarmStartConfig()
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.
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.
public CreateHyperParameterTuningJobRequest withWarmStartConfig(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.
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.
public List<Tag> getTags()
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
public void setTags(Collection<Tag> tags)
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
tags
- An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in
different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services
Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
public CreateHyperParameterTuningJobRequest withTags(Tag... tags)
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in
different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services
Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
public CreateHyperParameterTuningJobRequest withTags(Collection<Tag> tags)
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
tags
- An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in
different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services
Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
public void setAutotune(Autotune autotune)
Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
RetryStrategy: The number of times to retry a training job.
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
autotune
- Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the
following fields:
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
RetryStrategy: The number of times to retry a training job.
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
public Autotune getAutotune()
Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
RetryStrategy: The number of times to retry a training job.
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
ResourceLimits : The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
RetryStrategy: The number of times to retry a training job.
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
public CreateHyperParameterTuningJobRequest withAutotune(Autotune autotune)
Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
RetryStrategy: The number of times to retry a training job.
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
autotune
- Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the
following fields:
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
RetryStrategy: The number of times to retry a training job.
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
public String toString()
toString
in class Object
Object.toString()
public CreateHyperParameterTuningJobRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()