Interface CreateAlgorithmRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAlgorithmRequest.Builder,
,CreateAlgorithmRequest> SageMakerRequest.Builder
,SdkBuilder<CreateAlgorithmRequest.Builder,
,CreateAlgorithmRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAlgorithmRequest
-
Method Summary
Modifier and TypeMethodDescriptionalgorithmDescription
(String algorithmDescription) A description of the algorithm.algorithmName
(String algorithmName) The name of the algorithm.certifyForMarketplace
(Boolean certifyForMarketplace) Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.default CreateAlgorithmRequest.Builder
inferenceSpecification
(Consumer<InferenceSpecification.Builder> inferenceSpecification) Specifies details about inference jobs that the algorithm runs, including the following:inferenceSpecification
(InferenceSpecification inferenceSpecification) Specifies details about inference jobs that the algorithm runs, including the following:overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<Tag> tags) An array of key-value pairs.tags
(Consumer<Tag.Builder>... tags) An array of key-value pairs.An array of key-value pairs.default CreateAlgorithmRequest.Builder
trainingSpecification
(Consumer<TrainingSpecification.Builder> trainingSpecification) Specifies details about training jobs run by this algorithm, including the following:trainingSpecification
(TrainingSpecification trainingSpecification) Specifies details about training jobs run by this algorithm, including the following:default CreateAlgorithmRequest.Builder
validationSpecification
(Consumer<AlgorithmValidationSpecification.Builder> validationSpecification) Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.validationSpecification
(AlgorithmValidationSpecification validationSpecification) Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder
build
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
-
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
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
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
, andtest
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
, andtest
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
, andtest
channels.
TrainingSpecification.Builder
avoiding the need to create one manually viaTrainingSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrainingSpecification(TrainingSpecification)
.- Parameters:
trainingSpecification
- a consumer that will call methods onTrainingSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
InferenceSpecification.Builder
avoiding the need to create one manually viaInferenceSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinferenceSpecification(InferenceSpecification)
.- Parameters:
inferenceSpecification
- a consumer that will call methods onInferenceSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
validationSpecification
CreateAlgorithmRequest.Builder validationSpecification(AlgorithmValidationSpecification validationSpecification) Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.
- Parameters:
validationSpecification
- Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that 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 SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.
This is a convenience method that creates an instance of theAlgorithmValidationSpecification.Builder
avoiding the need to create one manually viaAlgorithmValidationSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalidationSpecification(AlgorithmValidationSpecification)
.- Parameters:
validationSpecification
- a consumer that will call methods onAlgorithmValidationSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
certifyForMarketplace
Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.
- Parameters:
certifyForMarketplace
- Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
- Parameters:
tags
- An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
- Parameters:
tags
- An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateAlgorithmRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateAlgorithmRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-