@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class HyperParameterSpecification extends Object implements Serializable, Cloneable, StructuredPojo
Defines a hyperparameter to be used by an algorithm.
Constructor and Description |
---|
HyperParameterSpecification() |
Modifier and Type | Method and Description |
---|---|
HyperParameterSpecification |
clone() |
boolean |
equals(Object obj) |
String |
getDefaultValue()
The default value for this hyperparameter.
|
String |
getDescription()
A brief description of the hyperparameter.
|
Boolean |
getIsRequired()
Indicates whether this hyperparameter is required.
|
Boolean |
getIsTunable()
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
|
String |
getName()
The name of this hyperparameter.
|
ParameterRange |
getRange()
The allowed range for this hyperparameter.
|
String |
getType()
The type of this hyperparameter.
|
int |
hashCode() |
Boolean |
isRequired()
Indicates whether this hyperparameter is required.
|
Boolean |
isTunable()
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDefaultValue(String defaultValue)
The default value for this hyperparameter.
|
void |
setDescription(String description)
A brief description of the hyperparameter.
|
void |
setIsRequired(Boolean isRequired)
Indicates whether this hyperparameter is required.
|
void |
setIsTunable(Boolean isTunable)
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
|
void |
setName(String name)
The name of this hyperparameter.
|
void |
setRange(ParameterRange range)
The allowed range for this hyperparameter.
|
void |
setType(String type)
The type of this hyperparameter.
|
String |
toString()
Returns a string representation of this object.
|
HyperParameterSpecification |
withDefaultValue(String defaultValue)
The default value for this hyperparameter.
|
HyperParameterSpecification |
withDescription(String description)
A brief description of the hyperparameter.
|
HyperParameterSpecification |
withIsRequired(Boolean isRequired)
Indicates whether this hyperparameter is required.
|
HyperParameterSpecification |
withIsTunable(Boolean isTunable)
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
|
HyperParameterSpecification |
withName(String name)
The name of this hyperparameter.
|
HyperParameterSpecification |
withRange(ParameterRange range)
The allowed range for this hyperparameter.
|
HyperParameterSpecification |
withType(ParameterType type)
The type of this hyperparameter.
|
HyperParameterSpecification |
withType(String type)
The type of this hyperparameter.
|
public void setName(String name)
The name of this hyperparameter. The name must be unique.
name
- The name of this hyperparameter. The name must be unique.public String getName()
The name of this hyperparameter. The name must be unique.
public HyperParameterSpecification withName(String name)
The name of this hyperparameter. The name must be unique.
name
- The name of this hyperparameter. The name must be unique.public void setDescription(String description)
A brief description of the hyperparameter.
description
- A brief description of the hyperparameter.public String getDescription()
A brief description of the hyperparameter.
public HyperParameterSpecification withDescription(String description)
A brief description of the hyperparameter.
description
- A brief description of the hyperparameter.public void setType(String type)
The type of this hyperparameter. The valid types are Integer
, Continuous
,
Categorical
, and FreeText
.
type
- The type of this hyperparameter. The valid types are Integer
, Continuous
,
Categorical
, and FreeText
.ParameterType
public String getType()
The type of this hyperparameter. The valid types are Integer
, Continuous
,
Categorical
, and FreeText
.
Integer
, Continuous
,
Categorical
, and FreeText
.ParameterType
public HyperParameterSpecification withType(String type)
The type of this hyperparameter. The valid types are Integer
, Continuous
,
Categorical
, and FreeText
.
type
- The type of this hyperparameter. The valid types are Integer
, Continuous
,
Categorical
, and FreeText
.ParameterType
public HyperParameterSpecification withType(ParameterType type)
The type of this hyperparameter. The valid types are Integer
, Continuous
,
Categorical
, and FreeText
.
type
- The type of this hyperparameter. The valid types are Integer
, Continuous
,
Categorical
, and FreeText
.ParameterType
public void setRange(ParameterRange range)
The allowed range for this hyperparameter.
range
- The allowed range for this hyperparameter.public ParameterRange getRange()
The allowed range for this hyperparameter.
public HyperParameterSpecification withRange(ParameterRange range)
The allowed range for this hyperparameter.
range
- The allowed range for this hyperparameter.public void setIsTunable(Boolean isTunable)
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
isTunable
- Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.public Boolean getIsTunable()
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
public HyperParameterSpecification withIsTunable(Boolean isTunable)
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
isTunable
- Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.public Boolean isTunable()
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
public void setIsRequired(Boolean isRequired)
Indicates whether this hyperparameter is required.
isRequired
- Indicates whether this hyperparameter is required.public Boolean getIsRequired()
Indicates whether this hyperparameter is required.
public HyperParameterSpecification withIsRequired(Boolean isRequired)
Indicates whether this hyperparameter is required.
isRequired
- Indicates whether this hyperparameter is required.public Boolean isRequired()
Indicates whether this hyperparameter is required.
public void setDefaultValue(String defaultValue)
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
defaultValue
- The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be
required.public String getDefaultValue()
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
public HyperParameterSpecification withDefaultValue(String defaultValue)
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
defaultValue
- The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be
required.public String toString()
toString
in class Object
Object.toString()
public HyperParameterSpecification clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.