HyperParameterTrainingJobSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.HyperParameterTrainingJobSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HyperParameterTrainingJobSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies summary information about a training job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HyperParameterTrainingJobSummary()

Constructors
Constructor and Description
`HyperParameterTrainingJobSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HyperParameterTrainingJobSummary`	`addTunedHyperParametersEntry(String key, String value)`
`HyperParameterTrainingJobSummary`	`clearTunedHyperParametersEntries()` Removes all the entries added into TunedHyperParameters.
`HyperParameterTrainingJobSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` The date and time that the training job was created.
`String`	`getFailureReason()` The reason that the training job failed.
`FinalHyperParameterTuningJobObjectiveMetric`	`getFinalHyperParameterTuningJobObjectiveMetric()` The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
`String`	`getObjectiveStatus()` The status of the objective metric for the training job:
`Date`	`getTrainingEndTime()` The date and time that the training job ended.
`String`	`getTrainingJobArn()` The Amazon Resource Name (ARN) of the training job.
`String`	`getTrainingJobName()` The name of the training job.
`String`	`getTrainingJobStatus()` The status of the training job.
`Date`	`getTrainingStartTime()` The date and time that the training job started.
`Map<String,String>`	`getTunedHyperParameters()` A list of the hyperparameters for which you specified ranges to search.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` The date and time that the training job was created.
`void`	`setFailureReason(String failureReason)` The reason that the training job failed.
`void`	`setFinalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetric finalHyperParameterTuningJobObjectiveMetric)` The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
`void`	`setObjectiveStatus(String objectiveStatus)` The status of the objective metric for the training job:
`void`	`setTrainingEndTime(Date trainingEndTime)` The date and time that the training job ended.
`void`	`setTrainingJobArn(String trainingJobArn)` The Amazon Resource Name (ARN) of the training job.
`void`	`setTrainingJobName(String trainingJobName)` The name of the training job.
`void`	`setTrainingJobStatus(String trainingJobStatus)` The status of the training job.
`void`	`setTrainingStartTime(Date trainingStartTime)` The date and time that the training job started.
`void`	`setTunedHyperParameters(Map<String,String> tunedHyperParameters)` A list of the hyperparameters for which you specified ranges to search.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`HyperParameterTrainingJobSummary`	`withCreationTime(Date creationTime)` The date and time that the training job was created.
`HyperParameterTrainingJobSummary`	`withFailureReason(String failureReason)` The reason that the training job failed.
`HyperParameterTrainingJobSummary`	`withFinalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetric finalHyperParameterTuningJobObjectiveMetric)` The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
`HyperParameterTrainingJobSummary`	`withObjectiveStatus(ObjectiveStatus objectiveStatus)` The status of the objective metric for the training job:
`HyperParameterTrainingJobSummary`	`withObjectiveStatus(String objectiveStatus)` The status of the objective metric for the training job:
`HyperParameterTrainingJobSummary`	`withTrainingEndTime(Date trainingEndTime)` The date and time that the training job ended.
`HyperParameterTrainingJobSummary`	`withTrainingJobArn(String trainingJobArn)` The Amazon Resource Name (ARN) of the training job.
`HyperParameterTrainingJobSummary`	`withTrainingJobName(String trainingJobName)` The name of the training job.
`HyperParameterTrainingJobSummary`	`withTrainingJobStatus(String trainingJobStatus)` The status of the training job.
`HyperParameterTrainingJobSummary`	`withTrainingJobStatus(TrainingJobStatus trainingJobStatus)` The status of the training job.
`HyperParameterTrainingJobSummary`	`withTrainingStartTime(Date trainingStartTime)` The date and time that the training job started.
`HyperParameterTrainingJobSummary`	`withTunedHyperParameters(Map<String,String> tunedHyperParameters)` A list of the hyperparameters for which you specified ranges to search.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HyperParameterTrainingJobSummary
```
public HyperParameterTrainingJobSummary()
```
- Method Detail
  - setTrainingJobName
```
public void setTrainingJobName(String trainingJobName)
```
    The name of the training job.
    
    Parameters:
    
    trainingJobName - The name of the training job.
  - getTrainingJobName
```
public String getTrainingJobName()
```
    The name of the training job.
    
    Returns:
    
    The name of the training job.
  - withTrainingJobName
```
public HyperParameterTrainingJobSummary withTrainingJobName(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.
  - setTrainingJobArn
```
public void setTrainingJobArn(String trainingJobArn)
```
    The Amazon Resource Name (ARN) of the training job.
    
    Parameters:
    
    trainingJobArn - The Amazon Resource Name (ARN) of the training job.
  - getTrainingJobArn
```
public String getTrainingJobArn()
```
    The Amazon Resource Name (ARN) of the training job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the training job.
  - withTrainingJobArn
```
public HyperParameterTrainingJobSummary withTrainingJobArn(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.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time that the training job was created.
    
    Parameters:
    
    creationTime - The date and time that the training job was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time that the training job was created.
    
    Returns:
    
    The date and time that the training job was created.
  - withCreationTime
```
public HyperParameterTrainingJobSummary withCreationTime(Date 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.
  - setTrainingStartTime
```
public void setTrainingStartTime(Date trainingStartTime)
```
    The date and time that the training job started.
    
    Parameters:
    
    trainingStartTime - The date and time that the training job started.
  - getTrainingStartTime
```
public Date getTrainingStartTime()
```
    The date and time that the training job started.
    
    Returns:
    
    The date and time that the training job started.
  - withTrainingStartTime
```
public HyperParameterTrainingJobSummary withTrainingStartTime(Date 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.
  - setTrainingEndTime
```
public void setTrainingEndTime(Date trainingEndTime)
```
    The date and time that the training job ended.
    
    Parameters:
    
    trainingEndTime - The date and time that the training job ended.
  - getTrainingEndTime
```
public Date getTrainingEndTime()
```
    The date and time that the training job ended.
    
    Returns:
    
    The date and time that the training job ended.
  - withTrainingEndTime
```
public HyperParameterTrainingJobSummary withTrainingEndTime(Date 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.
  - setTrainingJobStatus
```
public void setTrainingJobStatus(String trainingJobStatus)
```
    The status of the training job.
    
    Parameters:
    
    trainingJobStatus - The status of the training job.
    
    See Also:
    
    TrainingJobStatus
  - getTrainingJobStatus
```
public String getTrainingJobStatus()
```
    The status of the training job.
    
    Returns:
    
    The status of the training job.
    
    See Also:
    
    TrainingJobStatus
  - withTrainingJobStatus
```
public HyperParameterTrainingJobSummary withTrainingJobStatus(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
  - withTrainingJobStatus
```
public HyperParameterTrainingJobSummary withTrainingJobStatus(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
  - getTunedHyperParameters
```
public Map<String,String> getTunedHyperParameters()
```
    A list of the hyperparameters for which you specified ranges to search.
    
    Returns:
    
    A list of the hyperparameters for which you specified ranges to search.
  - setTunedHyperParameters
```
public void setTunedHyperParameters(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.
  - withTunedHyperParameters
```
public HyperParameterTrainingJobSummary withTunedHyperParameters(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.
  - addTunedHyperParametersEntry
```
public HyperParameterTrainingJobSummary addTunedHyperParametersEntry(String key,
                                                                     String value)
```
  - clearTunedHyperParametersEntries
```
public HyperParameterTrainingJobSummary clearTunedHyperParametersEntries()
```
    Removes all the entries added into TunedHyperParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    The reason that the training job failed.
    
    Parameters:
    
    failureReason - The reason that the training job failed.
  - getFailureReason
```
public String getFailureReason()
```
    The reason that the training job failed.
    
    Returns:
    
    The reason that the training job failed.
  - withFailureReason
```
public HyperParameterTrainingJobSummary withFailureReason(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.
  - setFinalHyperParameterTuningJobObjectiveMetric
```
public void setFinalHyperParameterTuningJobObjectiveMetric(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.
  - getFinalHyperParameterTuningJobObjectiveMetric
```
public FinalHyperParameterTuningJobObjectiveMetric getFinalHyperParameterTuningJobObjectiveMetric()
```
    The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
    
    Returns:
    
    The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
  - withFinalHyperParameterTuningJobObjectiveMetric
```
public HyperParameterTrainingJobSummary withFinalHyperParameterTuningJobObjectiveMetric(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.
  - setObjectiveStatus
```
public void setObjectiveStatus(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.
    See Also:
    
    ObjectiveStatus
  - getObjectiveStatus
```
public String getObjectiveStatus()
```
    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:
    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.
    See Also:
    
    ObjectiveStatus
  - withObjectiveStatus
```
public HyperParameterTrainingJobSummary withObjectiveStatus(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
  - withObjectiveStatus
```
public HyperParameterTrainingJobSummary withObjectiveStatus(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
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public HyperParameterTrainingJobSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class HyperParameterTrainingJobSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HyperParameterTrainingJobSummary

Method Detail

setTrainingJobName

getTrainingJobName

withTrainingJobName

setTrainingJobArn

getTrainingJobArn

withTrainingJobArn

setCreationTime

getCreationTime

withCreationTime

setTrainingStartTime

getTrainingStartTime

withTrainingStartTime

setTrainingEndTime

getTrainingEndTime

withTrainingEndTime

setTrainingJobStatus

getTrainingJobStatus

withTrainingJobStatus

withTrainingJobStatus

getTunedHyperParameters

setTunedHyperParameters

withTunedHyperParameters

addTunedHyperParametersEntry

clearTunedHyperParametersEntries

setFailureReason

getFailureReason

withFailureReason

setFinalHyperParameterTuningJobObjectiveMetric

getFinalHyperParameterTuningJobObjectiveMetric

withFinalHyperParameterTuningJobObjectiveMetric

setObjectiveStatus

getObjectiveStatus

withObjectiveStatus

withObjectiveStatus

toString

equals

hashCode

clone

marshall