Interface HyperParameterSpecification.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<HyperParameterSpecification.Builder,
,HyperParameterSpecification> SdkBuilder<HyperParameterSpecification.Builder,
,HyperParameterSpecification> SdkPojo
- Enclosing class:
HyperParameterSpecification
-
Method Summary
Modifier and TypeMethodDescriptiondefaultValue
(String defaultValue) The default value for this hyperparameter.description
(String description) A brief description of the hyperparameter.isRequired
(Boolean isRequired) Indicates whether this hyperparameter is required.Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.The name of this hyperparameter.range
(Consumer<ParameterRange.Builder> range) The allowed range for this hyperparameter.range
(ParameterRange range) The allowed range for this hyperparameter.The type of this hyperparameter.type
(ParameterType type) The type of this hyperparameter.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of this hyperparameter. The name must be unique.
- Parameters:
name
- The name of this hyperparameter. The name must be unique.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A brief description of the hyperparameter.
- Parameters:
description
- A brief description of the hyperparameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The type of this hyperparameter. The valid types are
Integer
,Continuous
,Categorical
, andFreeText
.- Parameters:
type
- The type of this hyperparameter. The valid types areInteger
,Continuous
,Categorical
, andFreeText
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The type of this hyperparameter. The valid types are
Integer
,Continuous
,Categorical
, andFreeText
.- Parameters:
type
- The type of this hyperparameter. The valid types areInteger
,Continuous
,Categorical
, andFreeText
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
range
The allowed range for this hyperparameter.
- Parameters:
range
- The allowed range for this hyperparameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
range
The allowed range for this hyperparameter.
This is a convenience method that creates an instance of theParameterRange.Builder
avoiding the need to create one manually viaParameterRange.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torange(ParameterRange)
.- Parameters:
range
- a consumer that will call methods onParameterRange.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
isTunable
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
- Parameters:
isTunable
- Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isRequired
Indicates whether this hyperparameter is required.
- Parameters:
isRequired
- Indicates whether this hyperparameter is required.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultValue
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
- Parameters:
defaultValue
- The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-