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 and 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) The input mode that the algorithm supports: File or Pipe.
HyperParameterAlgorithmSpecification.Builder	trainingInputMode(TrainingInputMode trainingInputMode) The input mode that the algorithm supports: File or Pipe.

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

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

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.

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.

Returns:

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

trainingInputMode

HyperParameterAlgorithmSpecification.Builder trainingInputMode(String trainingInputMode)

The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

For more information about input modes, see Algorithms.

Parameters:

trainingInputMode - The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

For more information about input modes, see Algorithms.

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)

The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

For more information about input modes, see Algorithms.

Parameters:

trainingInputMode - The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

For more information about input modes, see Algorithms.

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #metricDefinitions(List).

Parameters:

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

Returns:

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

See Also:

#metricDefinitions(List)