HyperParameterTrainingJobSummary.Builder (AWS Java SDK :: Services

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

All Methods Instance Methods Abstract Methods Default Methods
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)` Specifies the time when the training job ends on training instances.
`HyperParameterTrainingJobSummary.Builder`	`trainingJobArn(String trainingJobArn)` The Amazon Resource Name (ARN) of the training job.
`HyperParameterTrainingJobSummary.Builder`	`trainingJobDefinitionName(String trainingJobDefinitionName)` The training job definition name.
`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 HyperParameter tuning job that launched the training job.

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
  - trainingJobDefinitionName
```
HyperParameterTrainingJobSummary.Builder trainingJobDefinitionName(String trainingJobDefinitionName)
```
    The training job definition name.
    
    Parameters:
    
    trainingJobDefinitionName - The training job definition name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 HyperParameter tuning job that launched the training job.
    
    Parameters:
    
    tuningJobName - The HyperParameter tuning job that launched the 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)
```
    Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
    
    Parameters:
    
    trainingEndTime - Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
    
    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

Interface HyperParameterTrainingJobSummary.Builder

Method Summary

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

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

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

Method Detail

trainingJobDefinitionName

trainingJobName

trainingJobArn

tuningJobName

creationTime

trainingStartTime

trainingEndTime

trainingJobStatus

trainingJobStatus

tunedHyperParameters

failureReason

finalHyperParameterTuningJobObjectiveMetric

finalHyperParameterTuningJobObjectiveMetric

objectiveStatus

objectiveStatus