Class FinalHyperParameterTuningJobObjectiveMetric
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FinalHyperParameterTuningJobObjectiveMetric.Builder,
FinalHyperParameterTuningJobObjectiveMetric>
Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You
define the objective metric in the HyperParameterTuningJobObjective
parameter of HyperParameterTuningJobConfig.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The name of the objective metric.static Class
<? extends FinalHyperParameterTuningJobObjectiveMetric.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Select if you want to minimize or maximize the objective metric during hyperparameter tuning.final String
Select if you want to minimize or maximize the objective metric during hyperparameter tuning.final Float
value()
The value of the objective metric.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
If the service returns an enum value that is not available in the current SDK version,
type
will returnHyperParameterTuningJobObjectiveType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
- See Also:
-
typeAsString
Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
If the service returns an enum value that is not available in the current SDK version,
type
will returnHyperParameterTuningJobObjectiveType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
- See Also:
-
metricName
The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.
- Returns:
- The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.
-
value
The value of the objective metric.
- Returns:
- The value of the objective metric.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<FinalHyperParameterTuningJobObjectiveMetric.Builder,
FinalHyperParameterTuningJobObjectiveMetric> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends FinalHyperParameterTuningJobObjectiveMetric.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-