software.amazon.awssdk.services.sagemaker.model

Interface HyperParameterSpecification.Builder

All Superinterfaces:

Buildable, CopyableBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>, SdkBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>, SdkPojo

Enclosing class:

HyperParameterSpecification

public static interface HyperParameterSpecification.Builder
extends SdkPojo, CopyableBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>

Method Summary

Modifier and Type	Method and Description
HyperParameterSpecification.Builder	defaultValue(String defaultValue) The default value for this hyperparameter.
HyperParameterSpecification.Builder	description(String description) A brief description of the hyperparameter.
HyperParameterSpecification.Builder	isRequired(Boolean isRequired) Indicates whether this hyperparameter is required.
HyperParameterSpecification.Builder	isTunable(Boolean isTunable) Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
HyperParameterSpecification.Builder	name(String name) The name of this hyperparameter.
default HyperParameterSpecification.Builder	range(Consumer<ParameterRange.Builder> range) The allowed range for this hyperparameter.
HyperParameterSpecification.Builder	range(ParameterRange range) The allowed range for this hyperparameter.
HyperParameterSpecification.Builder	type(ParameterType type) The type of this hyperparameter.
HyperParameterSpecification.Builder	type(String type) The type of this hyperparameter.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

HyperParameterSpecification.Builder name(String 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

HyperParameterSpecification.Builder description(String 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

HyperParameterSpecification.Builder type(String type)

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Parameters:

type - The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParameterType, ParameterType

type

HyperParameterSpecification.Builder type(ParameterType type)

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Parameters:

type - The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParameterType, ParameterType

range

HyperParameterSpecification.Builder range(ParameterRange 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

default HyperParameterSpecification.Builder range(Consumer<ParameterRange.Builder> range)

The allowed range for this hyperparameter.

This is a convenience method that creates an instance of the ParameterRange.Builder avoiding the need to create one manually via ParameterRange.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to range(ParameterRange).

Parameters:

range - a consumer that will call methods on ParameterRange.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

range(ParameterRange)

isTunable

HyperParameterSpecification.Builder isTunable(Boolean 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

HyperParameterSpecification.Builder isRequired(Boolean 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

HyperParameterSpecification.Builder defaultValue(String 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.