Interface DescribeHyperParameterTuningJobResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeHyperParameterTuningJobResponse.Builder,
,DescribeHyperParameterTuningJobResponse> SageMakerResponse.Builder
,SdkBuilder<DescribeHyperParameterTuningJobResponse.Builder,
,DescribeHyperParameterTuningJobResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeHyperParameterTuningJobResponse
-
Method Summary
Modifier and TypeMethodDescriptionautotune
(Consumer<Autotune.Builder> autotune) A flag to indicate if autotune is enabled for the hyperparameter tuning job.A flag to indicate if autotune is enabled for the hyperparameter tuning job.bestTrainingJob
(Consumer<HyperParameterTrainingJobSummary.Builder> bestTrainingJob) A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.bestTrainingJob
(HyperParameterTrainingJobSummary bestTrainingJob) A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.consumedResources
(Consumer<HyperParameterTuningJobConsumedResources.Builder> consumedResources) Sets the value of the ConsumedResources property for this object.consumedResources
(HyperParameterTuningJobConsumedResources consumedResources) Sets the value of the ConsumedResources property for this object.creationTime
(Instant creationTime) The date and time that the tuning job started.failureReason
(String failureReason) If the tuning job failed, the reason it failed.hyperParameterTuningEndTime
(Instant hyperParameterTuningEndTime) The date and time that the tuning job ended.hyperParameterTuningJobArn
(String hyperParameterTuningJobArn) The Amazon Resource Name (ARN) of the tuning job.hyperParameterTuningJobConfig
(Consumer<HyperParameterTuningJobConfig.Builder> hyperParameterTuningJobConfig) The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.hyperParameterTuningJobConfig
(HyperParameterTuningJobConfig hyperParameterTuningJobConfig) The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.hyperParameterTuningJobName
(String hyperParameterTuningJobName) The name of the hyperparameter tuning job.hyperParameterTuningJobStatus
(String hyperParameterTuningJobStatus) The status of the tuning job.hyperParameterTuningJobStatus
(HyperParameterTuningJobStatus hyperParameterTuningJobStatus) The status of the tuning job.lastModifiedTime
(Instant lastModifiedTime) The date and time that the status of the tuning job was modified.objectiveStatusCounters
(Consumer<ObjectiveStatusCounters.Builder> objectiveStatusCounters) The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.objectiveStatusCounters
(ObjectiveStatusCounters objectiveStatusCounters) The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.overallBestTrainingJob
(Consumer<HyperParameterTrainingJobSummary.Builder> overallBestTrainingJob) If the hyperparameter tuning job is an warm start tuning job with aWarmStartType
ofIDENTICAL_DATA_AND_ALGORITHM
, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.overallBestTrainingJob
(HyperParameterTrainingJobSummary overallBestTrainingJob) If the hyperparameter tuning job is an warm start tuning job with aWarmStartType
ofIDENTICAL_DATA_AND_ALGORITHM
, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.trainingJobDefinition
(Consumer<HyperParameterTrainingJobDefinition.Builder> trainingJobDefinition) The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.trainingJobDefinition
(HyperParameterTrainingJobDefinition trainingJobDefinition) The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.trainingJobDefinitions
(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions) A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.trainingJobDefinitions
(Consumer<HyperParameterTrainingJobDefinition.Builder>... trainingJobDefinitions) A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.trainingJobDefinitions
(HyperParameterTrainingJobDefinition... trainingJobDefinitions) A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.trainingJobStatusCounters
(Consumer<TrainingJobStatusCounters.Builder> trainingJobStatusCounters) The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.trainingJobStatusCounters
(TrainingJobStatusCounters trainingJobStatusCounters) The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.tuningJobCompletionDetails
(Consumer<HyperParameterTuningJobCompletionDetails.Builder> tuningJobCompletionDetails) Tuning job completion information returned as the response from a hyperparameter tuning job.tuningJobCompletionDetails
(HyperParameterTuningJobCompletionDetails tuningJobCompletionDetails) Tuning job completion information returned as the response from a hyperparameter tuning job.warmStartConfig
(Consumer<HyperParameterTuningJobWarmStartConfig.Builder> warmStartConfig) The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point.warmStartConfig
(HyperParameterTuningJobWarmStartConfig warmStartConfig) The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
hyperParameterTuningJobName
DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobName(String hyperParameterTuningJobName) The name of the hyperparameter tuning job.
- Parameters:
hyperParameterTuningJobName
- The name of the hyperparameter tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hyperParameterTuningJobArn
DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobArn(String hyperParameterTuningJobArn) The Amazon Resource Name (ARN) of the tuning job.
- Parameters:
hyperParameterTuningJobArn
- The Amazon Resource Name (ARN) of the tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hyperParameterTuningJobConfig
DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobConfig(HyperParameterTuningJobConfig hyperParameterTuningJobConfig) The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
- Parameters:
hyperParameterTuningJobConfig
- The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hyperParameterTuningJobConfig
default DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobConfig(Consumer<HyperParameterTuningJobConfig.Builder> hyperParameterTuningJobConfig) The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
This is a convenience method that creates an instance of theHyperParameterTuningJobConfig.Builder
avoiding the need to create one manually viaHyperParameterTuningJobConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohyperParameterTuningJobConfig(HyperParameterTuningJobConfig)
.- Parameters:
hyperParameterTuningJobConfig
- a consumer that will call methods onHyperParameterTuningJobConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
trainingJobDefinition
DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinition(HyperParameterTrainingJobDefinition trainingJobDefinition) The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
- Parameters:
trainingJobDefinition
- The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingJobDefinition
default DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinition(Consumer<HyperParameterTrainingJobDefinition.Builder> trainingJobDefinition) The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
This is a convenience method that creates an instance of theHyperParameterTrainingJobDefinition.Builder
avoiding the need to create one manually viaHyperParameterTrainingJobDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrainingJobDefinition(HyperParameterTrainingJobDefinition)
.- Parameters:
trainingJobDefinition
- a consumer that will call methods onHyperParameterTrainingJobDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
trainingJobDefinitions
DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinitions(Collection<HyperParameterTrainingJobDefinition> trainingJobDefinitions) A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
- Parameters:
trainingJobDefinitions
- A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingJobDefinitions
DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinitions(HyperParameterTrainingJobDefinition... trainingJobDefinitions) A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
- Parameters:
trainingJobDefinitions
- A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingJobDefinitions
DescribeHyperParameterTuningJobResponse.Builder trainingJobDefinitions(Consumer<HyperParameterTrainingJobDefinition.Builder>... trainingJobDefinitions) A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
This is a convenience method that creates an instance of theHyperParameterTrainingJobDefinition.Builder
avoiding the need to create one manually viaHyperParameterTrainingJobDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrainingJobDefinitions(List<HyperParameterTrainingJobDefinition>)
.- Parameters:
trainingJobDefinitions
- a consumer that will call methods onHyperParameterTrainingJobDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hyperParameterTuningJobStatus
DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobStatus(String hyperParameterTuningJobStatus) The status of the tuning job.
- Parameters:
hyperParameterTuningJobStatus
- The status of the tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hyperParameterTuningJobStatus
DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus) The status of the tuning job.
- Parameters:
hyperParameterTuningJobStatus
- The status of the tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
creationTime
The date and time that the tuning job started.
- Parameters:
creationTime
- The date and time that the tuning job started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hyperParameterTuningEndTime
DescribeHyperParameterTuningJobResponse.Builder hyperParameterTuningEndTime(Instant hyperParameterTuningEndTime) The date and time that the tuning job ended.
- Parameters:
hyperParameterTuningEndTime
- The date and time that the tuning job ended.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastModifiedTime
The date and time that the status of the tuning job was modified.
- Parameters:
lastModifiedTime
- The date and time that the status of the tuning job was modified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingJobStatusCounters
DescribeHyperParameterTuningJobResponse.Builder trainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters) The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
- Parameters:
trainingJobStatusCounters
- The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingJobStatusCounters
default DescribeHyperParameterTuningJobResponse.Builder trainingJobStatusCounters(Consumer<TrainingJobStatusCounters.Builder> trainingJobStatusCounters) The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
This is a convenience method that creates an instance of theTrainingJobStatusCounters.Builder
avoiding the need to create one manually viaTrainingJobStatusCounters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrainingJobStatusCounters(TrainingJobStatusCounters)
.- Parameters:
trainingJobStatusCounters
- a consumer that will call methods onTrainingJobStatusCounters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
objectiveStatusCounters
DescribeHyperParameterTuningJobResponse.Builder objectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters) The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
- Parameters:
objectiveStatusCounters
- The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
objectiveStatusCounters
default DescribeHyperParameterTuningJobResponse.Builder objectiveStatusCounters(Consumer<ObjectiveStatusCounters.Builder> objectiveStatusCounters) The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
This is a convenience method that creates an instance of theObjectiveStatusCounters.Builder
avoiding the need to create one manually viaObjectiveStatusCounters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toobjectiveStatusCounters(ObjectiveStatusCounters)
.- Parameters:
objectiveStatusCounters
- a consumer that will call methods onObjectiveStatusCounters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bestTrainingJob
DescribeHyperParameterTuningJobResponse.Builder bestTrainingJob(HyperParameterTrainingJobSummary bestTrainingJob) A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
- Parameters:
bestTrainingJob
- A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bestTrainingJob
default DescribeHyperParameterTuningJobResponse.Builder bestTrainingJob(Consumer<HyperParameterTrainingJobSummary.Builder> bestTrainingJob) A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
This is a convenience method that creates an instance of theHyperParameterTrainingJobSummary.Builder
avoiding the need to create one manually viaHyperParameterTrainingJobSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobestTrainingJob(HyperParameterTrainingJobSummary)
.- Parameters:
bestTrainingJob
- a consumer that will call methods onHyperParameterTrainingJobSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overallBestTrainingJob
DescribeHyperParameterTuningJobResponse.Builder overallBestTrainingJob(HyperParameterTrainingJobSummary overallBestTrainingJob) If the hyperparameter tuning job is an warm start tuning job with a
WarmStartType
ofIDENTICAL_DATA_AND_ALGORITHM
, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.- Parameters:
overallBestTrainingJob
- If the hyperparameter tuning job is an warm start tuning job with aWarmStartType
ofIDENTICAL_DATA_AND_ALGORITHM
, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overallBestTrainingJob
default DescribeHyperParameterTuningJobResponse.Builder overallBestTrainingJob(Consumer<HyperParameterTrainingJobSummary.Builder> overallBestTrainingJob) If the hyperparameter tuning job is an warm start tuning job with a
This is a convenience method that creates an instance of theWarmStartType
ofIDENTICAL_DATA_AND_ALGORITHM
, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.HyperParameterTrainingJobSummary.Builder
avoiding the need to create one manually viaHyperParameterTrainingJobSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooverallBestTrainingJob(HyperParameterTrainingJobSummary)
.- Parameters:
overallBestTrainingJob
- a consumer that will call methods onHyperParameterTrainingJobSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
warmStartConfig
DescribeHyperParameterTuningJobResponse.Builder warmStartConfig(HyperParameterTuningJobWarmStartConfig warmStartConfig) The configuration for starting the hyperparameter parameter 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.
- Parameters:
warmStartConfig
- The configuration for starting the hyperparameter parameter 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
warmStartConfig
default DescribeHyperParameterTuningJobResponse.Builder warmStartConfig(Consumer<HyperParameterTuningJobWarmStartConfig.Builder> warmStartConfig) The configuration for starting the hyperparameter parameter 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.
This is a convenience method that creates an instance of theHyperParameterTuningJobWarmStartConfig.Builder
avoiding the need to create one manually viaHyperParameterTuningJobWarmStartConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed towarmStartConfig(HyperParameterTuningJobWarmStartConfig)
.- Parameters:
warmStartConfig
- a consumer that will call methods onHyperParameterTuningJobWarmStartConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
autotune
A flag to indicate if autotune is enabled for the hyperparameter tuning job.
- Parameters:
autotune
- A flag to indicate if autotune is enabled for the hyperparameter tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autotune
default DescribeHyperParameterTuningJobResponse.Builder autotune(Consumer<Autotune.Builder> autotune) A flag to indicate if autotune is enabled for the hyperparameter tuning job.
This is a convenience method that creates an instance of theAutotune.Builder
avoiding the need to create one manually viaAutotune.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toautotune(Autotune)
.- Parameters:
autotune
- a consumer that will call methods onAutotune.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
failureReason
If the tuning job failed, the reason it failed.
- Parameters:
failureReason
- If the tuning job failed, the reason it failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tuningJobCompletionDetails
DescribeHyperParameterTuningJobResponse.Builder tuningJobCompletionDetails(HyperParameterTuningJobCompletionDetails tuningJobCompletionDetails) Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.
- Parameters:
tuningJobCompletionDetails
- Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tuningJobCompletionDetails
default DescribeHyperParameterTuningJobResponse.Builder tuningJobCompletionDetails(Consumer<HyperParameterTuningJobCompletionDetails.Builder> tuningJobCompletionDetails) Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.
This is a convenience method that creates an instance of theHyperParameterTuningJobCompletionDetails.Builder
avoiding the need to create one manually viaHyperParameterTuningJobCompletionDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totuningJobCompletionDetails(HyperParameterTuningJobCompletionDetails)
.- Parameters:
tuningJobCompletionDetails
- a consumer that will call methods onHyperParameterTuningJobCompletionDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
consumedResources
DescribeHyperParameterTuningJobResponse.Builder consumedResources(HyperParameterTuningJobConsumedResources consumedResources) Sets the value of the ConsumedResources property for this object.- Parameters:
consumedResources
- The new value for the ConsumedResources property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
consumedResources
default DescribeHyperParameterTuningJobResponse.Builder consumedResources(Consumer<HyperParameterTuningJobConsumedResources.Builder> consumedResources) Sets the value of the ConsumedResources property for this object. This is a convenience method that creates an instance of theHyperParameterTuningJobConsumedResources.Builder
avoiding the need to create one manually viaHyperParameterTuningJobConsumedResources.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconsumedResources(HyperParameterTuningJobConsumedResources)
.- Parameters:
consumedResources
- a consumer that will call methods onHyperParameterTuningJobConsumedResources.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-