Class HyperParameterSpecification
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HyperParameterSpecification.Builder,
HyperParameterSpecification>
Defines a hyperparameter to be used by an algorithm.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The default value for this hyperparameter.final String
A brief description of the hyperparameter.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
Indicates whether this hyperparameter is required.final Boolean
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.final String
name()
The name of this hyperparameter.final ParameterRange
range()
The allowed range for this hyperparameter.static Class
<? extends HyperParameterSpecification.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 ParameterType
type()
The type of this hyperparameter.final String
The type of this hyperparameter.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of this hyperparameter. The name must be unique.
- Returns:
- The name of this hyperparameter. The name must be unique.
-
description
A brief description of the hyperparameter.
- Returns:
- A brief description of the hyperparameter.
-
type
The type of this hyperparameter. The valid types are
Integer
,Continuous
,Categorical
, andFreeText
.If the service returns an enum value that is not available in the current SDK version,
type
will returnParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of this hyperparameter. The valid types are
Integer
,Continuous
,Categorical
, andFreeText
. - See Also:
-
typeAsString
The type of this hyperparameter. The valid types are
Integer
,Continuous
,Categorical
, andFreeText
.If the service returns an enum value that is not available in the current SDK version,
type
will returnParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of this hyperparameter. The valid types are
Integer
,Continuous
,Categorical
, andFreeText
. - See Also:
-
range
The allowed range for this hyperparameter.
- Returns:
- The allowed range for this hyperparameter.
-
isTunable
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
- Returns:
- Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
-
isRequired
Indicates whether this hyperparameter is required.
- Returns:
- Indicates whether this hyperparameter is required.
-
defaultValue
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
- Returns:
- The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
-
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<HyperParameterSpecification.Builder,
HyperParameterSpecification> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-