software.amazon.awssdk.services.sagemaker.model

Class CreateAlgorithmRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateAlgorithmRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAlgorithmRequest.Builder,CreateAlgorithmRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAlgorithmRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateAlgorithmRequest.Builder,CreateAlgorithmRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAlgorithmRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	algorithmDescription() A description of the algorithm.
String	algorithmName() The name of the algorithm.
static CreateAlgorithmRequest.Builder	builder()
Boolean	certifyForMarketplace() Whether to certify the algorithm so that it can be listed in AWS Marketplace.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
InferenceSpecification	inferenceSpecification() Specifies details about inference jobs that the algorithm runs, including the following:
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAlgorithmRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() An array of key-value pairs.
CreateAlgorithmRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TrainingSpecification	trainingSpecification() Specifies details about training jobs run by this algorithm, including the following:
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

algorithmName

public final String algorithmName()

The name of the algorithm.

Returns:

The name of the algorithm.

algorithmDescription

public final String algorithmDescription()

A description of the algorithm.

Returns:

A description of the algorithm.

trainingSpecification

public final 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.

Returns:

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.

inferenceSpecification

public final 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.

Returns:

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.

validationSpecification

public final 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.

Returns:

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.

certifyForMarketplace

public final Boolean certifyForMarketplace()

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

Returns:

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

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.

toBuilder

public CreateAlgorithmRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAlgorithmRequest.Builder,CreateAlgorithmRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateAlgorithmRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAlgorithmRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo