Class HyperParameterAlgorithmSpecification
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HyperParameterAlgorithmSpecification.Builder,
HyperParameterAlgorithmSpecification>
Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the resource algorithm to use for the hyperparameter tuning job.builder()
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 boolean
For responses, this returns true if the service returned a value for the MetricDefinitions property.final List
<MetricDefinition> An array of MetricDefinition objects that specify the metrics that the algorithm emits.static Class
<? extends HyperParameterAlgorithmSpecification.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.final String
The registry path of the Docker image that contains the training algorithm.final TrainingInputMode
Returns the value of the TrainingInputMode property for this object.final String
Returns the value of the TrainingInputMode property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
trainingImage
The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both
registry/repository[:tag]
andregistry/repository[@digest]
image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.- Returns:
- The registry path of the Docker image that contains the training algorithm. For information about Docker
registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both
registry/repository[:tag]
andregistry/repository[@digest]
image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
-
trainingInputMode
Returns the value of the TrainingInputMode property for this object.If the service returns an enum value that is not available in the current SDK version,
trainingInputMode
will returnTrainingInputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingInputModeAsString()
.- Returns:
- The value of the TrainingInputMode property for this object.
- See Also:
-
trainingInputModeAsString
Returns the value of the TrainingInputMode property for this object.If the service returns an enum value that is not available in the current SDK version,
trainingInputMode
will returnTrainingInputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingInputModeAsString()
.- Returns:
- The value of the TrainingInputMode property for this object.
- See Also:
-
algorithmName
The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for
TrainingImage
.- Returns:
- The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for
this parameter, do not specify a value for
TrainingImage
.
-
hasMetricDefinitions
public final boolean hasMetricDefinitions()For responses, this returns true if the service returned a value for the MetricDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
metricDefinitions
An array of MetricDefinition objects that specify the metrics that the algorithm emits.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetricDefinitions()
method.- Returns:
- An array of MetricDefinition objects that specify the metrics that the algorithm emits.
-
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<HyperParameterAlgorithmSpecification.Builder,
HyperParameterAlgorithmSpecification> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends HyperParameterAlgorithmSpecification.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
-