software.amazon.awssdk.services.sagemaker.model

Interface CreateAlgorithmRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAlgorithmRequest.Builder,CreateAlgorithmRequest>, SageMakerRequest.Builder, SdkBuilder<CreateAlgorithmRequest.Builder,CreateAlgorithmRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAlgorithmRequest

public static interface CreateAlgorithmRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateAlgorithmRequest.Builder,CreateAlgorithmRequest>

Method Summary

Modifier and Type	Method and Description
CreateAlgorithmRequest.Builder	algorithmDescription(String algorithmDescription) A description of the algorithm.
CreateAlgorithmRequest.Builder	algorithmName(String algorithmName) The name of the algorithm.
CreateAlgorithmRequest.Builder	certifyForMarketplace(Boolean certifyForMarketplace) Whether to certify the algorithm so that it can be listed in AWS Marketplace.
default CreateAlgorithmRequest.Builder	inferenceSpecification(Consumer<InferenceSpecification.Builder> inferenceSpecification) Specifies details about inference jobs that the algorithm runs, including the following:
CreateAlgorithmRequest.Builder	inferenceSpecification(InferenceSpecification inferenceSpecification) Specifies details about inference jobs that the algorithm runs, including the following:
CreateAlgorithmRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateAlgorithmRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default CreateAlgorithmRequest.Builder	trainingSpecification(Consumer<TrainingSpecification.Builder> trainingSpecification) Specifies details about training jobs run by this algorithm, including the following:
CreateAlgorithmRequest.Builder	trainingSpecification(TrainingSpecification trainingSpecification) Specifies details about training jobs run by this algorithm, including the following:
CreateAlgorithmRequest.Builder	validationSpecification(AlgorithmValidationSpecification validationSpecification) Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.
default CreateAlgorithmRequest.Builder	validationSpecification(Consumer<AlgorithmValidationSpecification.Builder> validationSpecification) Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

algorithmName

CreateAlgorithmRequest.Builder algorithmName(String algorithmName)

The name of the algorithm.

Parameters:

algorithmName - The name of the algorithm.

Returns:

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

algorithmDescription

CreateAlgorithmRequest.Builder algorithmDescription(String algorithmDescription)

A description of the algorithm.

Parameters:

algorithmDescription - A description of the algorithm.

Returns:

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

trainingSpecification

CreateAlgorithmRequest.Builder trainingSpecification(TrainingSpecification trainingSpecification)

Specifies details about training jobs run by this algorithm, including the following:

• The Amazon ECR path of the container and the version digest of the algorithm.

• The hyperparameters that the algorithm supports.

• The instance types that the algorithm supports for training.

• Whether the algorithm supports distributed training.

• The metrics that the algorithm emits to Amazon CloudWatch.

• Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

• The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

Parameters:

trainingSpecification - Specifies details about training jobs run by this algorithm, including the following:

• The Amazon ECR path of the container and the version digest of the algorithm.

• The hyperparameters that the algorithm supports.

• The instance types that the algorithm supports for training.

• Whether the algorithm supports distributed training.

• The metrics that the algorithm emits to Amazon CloudWatch.

• Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

• The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

Returns:

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

trainingSpecification

default CreateAlgorithmRequest.Builder trainingSpecification(Consumer<TrainingSpecification.Builder> trainingSpecification)

Specifies details about training jobs run by this algorithm, including the following:

• The Amazon ECR path of the container and the version digest of the algorithm.

• The hyperparameters that the algorithm supports.

• The instance types that the algorithm supports for training.

• Whether the algorithm supports distributed training.

• The metrics that the algorithm emits to Amazon CloudWatch.

• Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

• The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

This is a convenience that creates an instance of the TrainingSpecification.Builder avoiding the need to create one manually via TrainingSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trainingSpecification(TrainingSpecification).

Parameters:

trainingSpecification - a consumer that will call methods on TrainingSpecification.Builder

Returns:

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

See Also:

trainingSpecification(TrainingSpecification)

inferenceSpecification

CreateAlgorithmRequest.Builder inferenceSpecification(InferenceSpecification inferenceSpecification)

Specifies details about inference jobs that the algorithm runs, including the following:

• The Amazon ECR paths of containers that contain the inference code and model artifacts.

• The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

• The input and output content formats that the algorithm supports for inference.

Parameters:

inferenceSpecification - Specifies details about inference jobs that the algorithm runs, including the following:

• The Amazon ECR paths of containers that contain the inference code and model artifacts.

• The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

• The input and output content formats that the algorithm supports for inference.

Returns:

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

inferenceSpecification

default CreateAlgorithmRequest.Builder inferenceSpecification(Consumer<InferenceSpecification.Builder> inferenceSpecification)

Specifies details about inference jobs that the algorithm runs, including the following:

• The Amazon ECR paths of containers that contain the inference code and model artifacts.

• The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

• The input and output content formats that the algorithm supports for inference.

This is a convenience that creates an instance of the InferenceSpecification.Builder avoiding the need to create one manually via InferenceSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inferenceSpecification(InferenceSpecification).

Parameters:

inferenceSpecification - a consumer that will call methods on InferenceSpecification.Builder

Returns:

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

See Also:

inferenceSpecification(InferenceSpecification)

validationSpecification

CreateAlgorithmRequest.Builder validationSpecification(AlgorithmValidationSpecification validationSpecification)

Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

Parameters:

validationSpecification - Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

Returns:

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

validationSpecification

default CreateAlgorithmRequest.Builder validationSpecification(Consumer<AlgorithmValidationSpecification.Builder> validationSpecification)

Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

This is a convenience that creates an instance of the AlgorithmValidationSpecification.Builder avoiding the need to create one manually via AlgorithmValidationSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validationSpecification(AlgorithmValidationSpecification).

Parameters:

validationSpecification - a consumer that will call methods on AlgorithmValidationSpecification.Builder

Returns:

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

See Also:

validationSpecification(AlgorithmValidationSpecification)

certifyForMarketplace

CreateAlgorithmRequest.Builder certifyForMarketplace(Boolean certifyForMarketplace)

Whether to certify the algorithm so that it can be listed in AWS Marketplace.

Parameters:

certifyForMarketplace - Whether to certify the algorithm so that it can be listed in AWS Marketplace.

Returns:

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

overrideConfiguration

CreateAlgorithmRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateAlgorithmRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder