@Generated(value="software.amazon.awssdk:codegen") public final class HyperParameterSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>
Defines a hyperparameter to be used by an algorithm.
Modifier and Type | Class and Description |
---|---|
static interface |
HyperParameterSpecification.Builder |
Modifier and Type | Method and Description |
---|---|
static HyperParameterSpecification.Builder |
builder() |
String |
defaultValue()
The default value for this hyperparameter.
|
String |
description()
A brief description of the hyperparameter.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Boolean |
isRequired()
Indicates whether this hyperparameter is required.
|
Boolean |
isTunable()
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
|
String |
name()
The name of this hyperparameter.
|
ParameterRange |
range()
The allowed range for this hyperparameter.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends HyperParameterSpecification.Builder> |
serializableBuilderClass() |
HyperParameterSpecification.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
ParameterType |
type()
The type of this hyperparameter.
|
String |
typeAsString()
The type of this hyperparameter.
|
copy
public String name()
The name of this hyperparameter. The name must be unique.
public String description()
A brief description of the hyperparameter.
public ParameterType type()
The type of this hyperparameter. The valid types are Integer
, Continuous
,
Categorical
, and FreeText
.
If the service returns an enum value that is not available in the current SDK version, type
will return
ParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
Integer
, Continuous
,
Categorical
, and FreeText
.ParameterType
public String typeAsString()
The type of this hyperparameter. The valid types are Integer
, Continuous
,
Categorical
, and FreeText
.
If the service returns an enum value that is not available in the current SDK version, type
will return
ParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
Integer
, Continuous
,
Categorical
, and FreeText
.ParameterType
public ParameterRange range()
The allowed range for this hyperparameter.
public Boolean isTunable()
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
public Boolean isRequired()
Indicates whether this hyperparameter is required.
public String defaultValue()
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
public HyperParameterSpecification.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>
public static HyperParameterSpecification.Builder builder()
public static Class<? extends HyperParameterSpecification.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.