software.amazon.awssdk.services.sagemaker.model

Interface HyperParameterTrainingJobSummary.Builder

All Superinterfaces:

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

Enclosing class:

HyperParameterTrainingJobSummary

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

Method Summary

Modifier and Type	Method and Description
HyperParameterTrainingJobSummary.Builder	creationTime(Instant creationTime) The date and time that the training job was created.
HyperParameterTrainingJobSummary.Builder	failureReason(String failureReason) The reason that the training job failed.
default HyperParameterTrainingJobSummary.Builder	finalHyperParameterTuningJobObjectiveMetric(Consumer<FinalHyperParameterTuningJobObjectiveMetric.Builder> finalHyperParameterTuningJobObjectiveMetric) The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
HyperParameterTrainingJobSummary.Builder	finalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetric finalHyperParameterTuningJobObjectiveMetric) The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
HyperParameterTrainingJobSummary.Builder	objectiveStatus(ObjectiveStatus objectiveStatus) The status of the objective metric for the training job:
HyperParameterTrainingJobSummary.Builder	objectiveStatus(String objectiveStatus) The status of the objective metric for the training job:
HyperParameterTrainingJobSummary.Builder	trainingEndTime(Instant trainingEndTime) The date and time that the training job ended.
HyperParameterTrainingJobSummary.Builder	trainingJobArn(String trainingJobArn) The Amazon Resource Name (ARN) of the training job.
HyperParameterTrainingJobSummary.Builder	trainingJobName(String trainingJobName) The name of the training job.
HyperParameterTrainingJobSummary.Builder	trainingJobStatus(String trainingJobStatus) The status of the training job.
HyperParameterTrainingJobSummary.Builder	trainingJobStatus(TrainingJobStatus trainingJobStatus) The status of the training job.
HyperParameterTrainingJobSummary.Builder	trainingStartTime(Instant trainingStartTime) The date and time that the training job started.
HyperParameterTrainingJobSummary.Builder	tunedHyperParameters(Map<String,String> tunedHyperParameters) A list of the hyperparameters for which you specified ranges to search.
HyperParameterTrainingJobSummary.Builder	tuningJobName(String tuningJobName) The name of the hyperparameter tuning job that launched this training job.

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

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

trainingJobName

HyperParameterTrainingJobSummary.Builder trainingJobName(String trainingJobName)

The name of the training job.

Parameters:

trainingJobName - The name of the training job.

Returns:

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

trainingJobArn

HyperParameterTrainingJobSummary.Builder trainingJobArn(String trainingJobArn)

The Amazon Resource Name (ARN) of the training job.

Parameters:

trainingJobArn - The Amazon Resource Name (ARN) of the training job.

Returns:

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

tuningJobName

HyperParameterTrainingJobSummary.Builder tuningJobName(String tuningJobName)

The name of the hyperparameter tuning job that launched this training job.

Parameters:

tuningJobName - The name of the hyperparameter tuning job that launched this training job.

Returns:

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

creationTime

HyperParameterTrainingJobSummary.Builder creationTime(Instant creationTime)

The date and time that the training job was created.

Parameters:

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

Returns:

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

trainingStartTime

HyperParameterTrainingJobSummary.Builder trainingStartTime(Instant trainingStartTime)

The date and time that the training job started.

Parameters:

trainingStartTime - The date and time that the training job started.

Returns:

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

trainingEndTime

HyperParameterTrainingJobSummary.Builder trainingEndTime(Instant trainingEndTime)

The date and time that the training job ended.

Parameters:

trainingEndTime - The date and time that the training job ended.

Returns:

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

trainingJobStatus

HyperParameterTrainingJobSummary.Builder trainingJobStatus(String trainingJobStatus)

The status of the training job.

Parameters:

trainingJobStatus - The status of the training job.

Returns:

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

See Also:

TrainingJobStatus, TrainingJobStatus

trainingJobStatus

HyperParameterTrainingJobSummary.Builder trainingJobStatus(TrainingJobStatus trainingJobStatus)

The status of the training job.

Parameters:

trainingJobStatus - The status of the training job.

Returns:

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

See Also:

TrainingJobStatus, TrainingJobStatus

tunedHyperParameters

HyperParameterTrainingJobSummary.Builder tunedHyperParameters(Map<String,String> tunedHyperParameters)

A list of the hyperparameters for which you specified ranges to search.

Parameters:

tunedHyperParameters - A list of the hyperparameters for which you specified ranges to search.

Returns:

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

failureReason

HyperParameterTrainingJobSummary.Builder failureReason(String failureReason)

The reason that the training job failed.

Parameters:

failureReason - The reason that the training job failed.

Returns:

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

finalHyperParameterTuningJobObjectiveMetric

HyperParameterTrainingJobSummary.Builder finalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetric finalHyperParameterTuningJobObjectiveMetric)

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

Parameters:

finalHyperParameterTuningJobObjectiveMetric - The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

Returns:

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

finalHyperParameterTuningJobObjectiveMetric

default HyperParameterTrainingJobSummary.Builder finalHyperParameterTuningJobObjectiveMetric(Consumer<FinalHyperParameterTuningJobObjectiveMetric.Builder> finalHyperParameterTuningJobObjectiveMetric)

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

This is a convenience that creates an instance of the FinalHyperParameterTuningJobObjectiveMetric.Builder avoiding the need to create one manually via FinalHyperParameterTuningJobObjectiveMetric.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to finalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetric).

Parameters:

finalHyperParameterTuningJobObjectiveMetric - a consumer that will call methods on FinalHyperParameterTuningJobObjectiveMetric.Builder

Returns:

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

See Also:

finalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetric)

objectiveStatus

HyperParameterTrainingJobSummary.Builder objectiveStatus(String objectiveStatus)

The status of the objective metric for the training job:

• Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

• Pending: The training job is in progress and evaluation of its final objective metric is pending.

• Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

Parameters:

objectiveStatus - The status of the objective metric for the training job:

• Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

• Pending: The training job is in progress and evaluation of its final objective metric is pending.

• Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

Returns:

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

See Also:

ObjectiveStatus, ObjectiveStatus

objectiveStatus

HyperParameterTrainingJobSummary.Builder objectiveStatus(ObjectiveStatus objectiveStatus)

The status of the objective metric for the training job:

• Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

• Pending: The training job is in progress and evaluation of its final objective metric is pending.

• Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

Parameters:

objectiveStatus - The status of the objective metric for the training job:

• Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

• Pending: The training job is in progress and evaluation of its final objective metric is pending.

• Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

Returns:

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

See Also:

ObjectiveStatus, ObjectiveStatus