software.amazon.awssdk.services.sagemaker.model

Interface AlgorithmSpecification.Builder

All Superinterfaces:

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

Enclosing class:

AlgorithmSpecification

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

Method Summary

Modifier and Type	Method and Description
AlgorithmSpecification.Builder	algorithmName(String algorithmName) The name of the algorithm resource to use for the training job.
AlgorithmSpecification.Builder	enableSageMakerMetricsTimeSeries(Boolean enableSageMakerMetricsTimeSeries) To generate and save time-series metrics during training, set to true.
AlgorithmSpecification.Builder	metricDefinitions(Collection<MetricDefinition> metricDefinitions) A list of metric definition objects.
AlgorithmSpecification.Builder	metricDefinitions(Consumer<MetricDefinition.Builder>... metricDefinitions) A list of metric definition objects.
AlgorithmSpecification.Builder	metricDefinitions(MetricDefinition... metricDefinitions) A list of metric definition objects.
AlgorithmSpecification.Builder	trainingImage(String trainingImage) The registry path of the Docker image that contains the training algorithm.
AlgorithmSpecification.Builder	trainingInputMode(String trainingInputMode) Sets the value of the TrainingInputMode property for this object.
AlgorithmSpecification.Builder	trainingInputMode(TrainingInputMode trainingInputMode) Sets the value of the TrainingInputMode property for this object.

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

trainingImage

AlgorithmSpecification.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. Amazon 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. Amazon 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.

algorithmName

AlgorithmSpecification.Builder algorithmName(String algorithmName)

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Parameters:

algorithmName - The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Returns:

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

trainingInputMode

AlgorithmSpecification.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

AlgorithmSpecification.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

metricDefinitions

AlgorithmSpecification.Builder metricDefinitions(Collection<MetricDefinition> metricDefinitions)

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Parameters:

metricDefinitions - A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Returns:

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

metricDefinitions

AlgorithmSpecification.Builder metricDefinitions(MetricDefinition... metricDefinitions)

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Parameters:

metricDefinitions - A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Returns:

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

metricDefinitions

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

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

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)

enableSageMakerMetricsTimeSeries

AlgorithmSpecification.Builder enableSageMakerMetricsTimeSeries(Boolean enableSageMakerMetricsTimeSeries)

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

• You use one of the Amazon SageMaker built-in algorithms

• You use one of the following Prebuilt Amazon SageMaker Docker Images:

  • Tensorflow (version >= 1.15)

  • MXNet (version >= 1.6)

  • PyTorch (version >= 1.3)

• You specify at least one MetricDefinition

Parameters:

enableSageMakerMetricsTimeSeries - To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

• You use one of the Amazon SageMaker built-in algorithms

• You use one of the following Prebuilt Amazon SageMaker Docker Images:

  • Tensorflow (version >= 1.15)

  • MXNet (version >= 1.6)

  • PyTorch (version >= 1.3)

• You specify at least one MetricDefinition

Returns:

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