Package software.amazon.awssdk.services.sagemaker.model

Interface HyperParameterAlgorithmSpecification.Builder

All Superinterfaces:

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

Enclosing class:

HyperParameterAlgorithmSpecification

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

Method Summary

Modifier and Type	Method	Description
HyperParameterAlgorithmSpecification.Builder	algorithmName(String algorithmName)	The name of the resource algorithm to use for the hyperparameter tuning job.
HyperParameterAlgorithmSpecification.Builder	metricDefinitions(Collection<MetricDefinition> metricDefinitions)	An array of MetricDefinition objects that specify the metrics that the algorithm emits.
HyperParameterAlgorithmSpecification.Builder	metricDefinitions(Consumer<MetricDefinition.Builder>... metricDefinitions)	An array of MetricDefinition objects that specify the metrics that the algorithm emits.
HyperParameterAlgorithmSpecification.Builder	metricDefinitions(MetricDefinition... metricDefinitions)	An array of MetricDefinition objects that specify the metrics that the algorithm emits.
HyperParameterAlgorithmSpecification.Builder	trainingImage(String trainingImage)	The registry path of the Docker image that contains the training algorithm.
HyperParameterAlgorithmSpecification.Builder	trainingInputMode(String trainingInputMode)	Sets the value of the TrainingInputMode property for this object.
HyperParameterAlgorithmSpecification.Builder	trainingInputMode(TrainingInputMode trainingInputMode)	Sets the value of the TrainingInputMode property for this object.

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

trainingImage

HyperParameterAlgorithmSpecification.Builder trainingImage(String trainingImage)

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Parameters:

trainingImage - The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Returns:

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

trainingInputMode

HyperParameterAlgorithmSpecification.Builder trainingInputMode(String trainingInputMode)

Sets the value of the TrainingInputMode property for this object.

Parameters:

trainingInputMode - The new value for the TrainingInputMode property for this object.

Returns:

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

See Also:

• TrainingInputMode
• TrainingInputMode

trainingInputMode

HyperParameterAlgorithmSpecification.Builder trainingInputMode(TrainingInputMode trainingInputMode)

Sets the value of the TrainingInputMode property for this object.

Parameters:

trainingInputMode - The new value for the TrainingInputMode property for this object.

Returns:

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

See Also:

• TrainingInputMode
• TrainingInputMode

algorithmName

HyperParameterAlgorithmSpecification.Builder algorithmName(String algorithmName)

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Parameters:

algorithmName - The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Returns:

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

metricDefinitions

HyperParameterAlgorithmSpecification.Builder metricDefinitions(Collection<MetricDefinition> metricDefinitions)

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Parameters:

metricDefinitions - An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Returns:

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

metricDefinitions

HyperParameterAlgorithmSpecification.Builder metricDefinitions(MetricDefinition... metricDefinitions)

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Parameters:

metricDefinitions - An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Returns:

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

metricDefinitions

HyperParameterAlgorithmSpecification.Builder metricDefinitions(Consumer<MetricDefinition.Builder>... metricDefinitions)

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricDefinitions(List<MetricDefinition>).

Parameters:

metricDefinitions - a consumer that will call methods on MetricDefinition.Builder

Returns:

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

See Also:

• metricDefinitions(java.util.Collection<MetricDefinition>)