Class FinalHyperParameterTuningJobObjectiveMetric
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.FinalHyperParameterTuningJobObjectiveMetric
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FinalHyperParameterTuningJobObjectiveMetric.Builder,FinalHyperParameterTuningJobObjectiveMetric>
@Generated("software.amazon.awssdk:codegen") public final class FinalHyperParameterTuningJobObjectiveMetric extends Object implements SdkPojo, Serializable, 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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
FinalHyperParameterTuningJobObjectiveMetric.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FinalHyperParameterTuningJobObjectiveMetric.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
metricName()
The name of the objective metric.List<SdkField<?>>
sdkFields()
static Class<? extends FinalHyperParameterTuningJobObjectiveMetric.Builder>
serializableBuilderClass()
FinalHyperParameterTuningJobObjectiveMetric.Builder
toBuilder()
String
toString()
Returns a string representation of this object.HyperParameterTuningJobObjectiveType
type()
Select if you want to minimize or maximize the objective metric during hyperparameter tuning.String
typeAsString()
Select if you want to minimize or maximize the objective metric during hyperparameter tuning.Float
value()
The value of the objective metric.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
type
public final HyperParameterTuningJobObjectiveType 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:
HyperParameterTuningJobObjectiveType
-
typeAsString
public final String 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:
HyperParameterTuningJobObjectiveType
-
metricName
public final String 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
public final Float value()
The value of the objective metric.
- Returns:
- The value of the objective metric.
-
toBuilder
public FinalHyperParameterTuningJobObjectiveMetric.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<FinalHyperParameterTuningJobObjectiveMetric.Builder,FinalHyperParameterTuningJobObjectiveMetric>
-
builder
public static FinalHyperParameterTuningJobObjectiveMetric.Builder builder()
-
serializableBuilderClass
public static Class<? extends FinalHyperParameterTuningJobObjectiveMetric.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-