software.amazon.awssdk.services.sagemaker.model

Interface HyperParameterTuningJobSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<HyperParameterTuningJobSummary.Builder,HyperParameterTuningJobSummary>, SdkBuilder<HyperParameterTuningJobSummary.Builder,HyperParameterTuningJobSummary>, SdkPojo

Enclosing class:

HyperParameterTuningJobSummary

public static interface HyperParameterTuningJobSummary.Builder
extends SdkPojo, CopyableBuilder<HyperParameterTuningJobSummary.Builder,HyperParameterTuningJobSummary>

Method Summary

Modifier and Type	Method and Description
HyperParameterTuningJobSummary.Builder	creationTime(Instant creationTime) The date and time that the tuning job was created.
HyperParameterTuningJobSummary.Builder	hyperParameterTuningEndTime(Instant hyperParameterTuningEndTime) The date and time that the tuning job ended.
HyperParameterTuningJobSummary.Builder	hyperParameterTuningJobArn(String hyperParameterTuningJobArn) The Amazon Resource Name (ARN) of the tuning job.
HyperParameterTuningJobSummary.Builder	hyperParameterTuningJobName(String hyperParameterTuningJobName) The name of the tuning job.
HyperParameterTuningJobSummary.Builder	hyperParameterTuningJobStatus(HyperParameterTuningJobStatus hyperParameterTuningJobStatus) The status of the tuning job.
HyperParameterTuningJobSummary.Builder	hyperParameterTuningJobStatus(String hyperParameterTuningJobStatus) The status of the tuning job.
HyperParameterTuningJobSummary.Builder	lastModifiedTime(Instant lastModifiedTime) The date and time that the tuning job was modified.
default HyperParameterTuningJobSummary.Builder	objectiveStatusCounters(Consumer<ObjectiveStatusCounters.Builder> objectiveStatusCounters) The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
HyperParameterTuningJobSummary.Builder	objectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters) The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
default HyperParameterTuningJobSummary.Builder	resourceLimits(Consumer<ResourceLimits.Builder> resourceLimits) The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
HyperParameterTuningJobSummary.Builder	resourceLimits(ResourceLimits resourceLimits) The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
HyperParameterTuningJobSummary.Builder	strategy(HyperParameterTuningJobStrategyType strategy) Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.
HyperParameterTuningJobSummary.Builder	strategy(String strategy) Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.
default HyperParameterTuningJobSummary.Builder	trainingJobStatusCounters(Consumer<TrainingJobStatusCounters.Builder> trainingJobStatusCounters) The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
HyperParameterTuningJobSummary.Builder	trainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters) The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

hyperParameterTuningJobName

HyperParameterTuningJobSummary.Builder hyperParameterTuningJobName(String hyperParameterTuningJobName)

The name of the tuning job.

Parameters:

hyperParameterTuningJobName - The name of the tuning job.

Returns:

Returns a reference to this object so that method calls can be chained together.

hyperParameterTuningJobArn

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

hyperParameterTuningJobStatus

HyperParameterTuningJobSummary.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, HyperParameterTuningJobStatus

hyperParameterTuningJobStatus

HyperParameterTuningJobSummary.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:

HyperParameterTuningJobStatus, HyperParameterTuningJobStatus

strategy

HyperParameterTuningJobSummary.Builder strategy(String strategy)

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

Parameters:

strategy - Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HyperParameterTuningJobStrategyType, HyperParameterTuningJobStrategyType

strategy

HyperParameterTuningJobSummary.Builder strategy(HyperParameterTuningJobStrategyType strategy)

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

Parameters:

strategy - Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HyperParameterTuningJobStrategyType, HyperParameterTuningJobStrategyType

creationTime

HyperParameterTuningJobSummary.Builder creationTime(Instant creationTime)

The date and time that the tuning job was created.

Parameters:

creationTime - The date and time that the tuning job was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

hyperParameterTuningEndTime

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

HyperParameterTuningJobSummary.Builder lastModifiedTime(Instant lastModifiedTime)

The date and time that the tuning job was modified.

Parameters:

lastModifiedTime - The date and time that the tuning job was modified.

Returns:

Returns a reference to this object so that method calls can be chained together.

trainingJobStatusCounters

HyperParameterTuningJobSummary.Builder trainingJobStatusCounters(TrainingJobStatusCounters trainingJobStatusCounters)

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

Parameters:

trainingJobStatusCounters - The TrainingJobStatusCounters object that specifies the numbers 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 HyperParameterTuningJobSummary.Builder trainingJobStatusCounters(Consumer<TrainingJobStatusCounters.Builder> trainingJobStatusCounters)

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

This is a convenience method that creates an instance of the TrainingJobStatusCounters.Builder avoiding the need to create one manually via TrainingJobStatusCounters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trainingJobStatusCounters(TrainingJobStatusCounters).

Parameters:

trainingJobStatusCounters - a consumer that will call methods on TrainingJobStatusCounters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

trainingJobStatusCounters(TrainingJobStatusCounters)

objectiveStatusCounters

HyperParameterTuningJobSummary.Builder objectiveStatusCounters(ObjectiveStatusCounters objectiveStatusCounters)

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

Parameters:

objectiveStatusCounters - The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

Returns:

Returns a reference to this object so that method calls can be chained together.

objectiveStatusCounters

default HyperParameterTuningJobSummary.Builder objectiveStatusCounters(Consumer<ObjectiveStatusCounters.Builder> objectiveStatusCounters)

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

This is a convenience method that creates an instance of the ObjectiveStatusCounters.Builder avoiding the need to create one manually via ObjectiveStatusCounters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to objectiveStatusCounters(ObjectiveStatusCounters).

Parameters:

objectiveStatusCounters - a consumer that will call methods on ObjectiveStatusCounters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

objectiveStatusCounters(ObjectiveStatusCounters)

resourceLimits

HyperParameterTuningJobSummary.Builder resourceLimits(ResourceLimits resourceLimits)

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

Parameters:

resourceLimits - The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceLimits

default HyperParameterTuningJobSummary.Builder resourceLimits(Consumer<ResourceLimits.Builder> resourceLimits)

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

This is a convenience method that creates an instance of the ResourceLimits.Builder avoiding the need to create one manually via ResourceLimits.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceLimits(ResourceLimits).

Parameters:

resourceLimits - a consumer that will call methods on ResourceLimits.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

resourceLimits(ResourceLimits)