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 Marektplace.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
InferenceSpecification	inferenceSpecification() Specifies details about inference jobs that the algorithm runs, including the following:
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAlgorithmRequest.Builder>	serializableBuilderClass()
CreateAlgorithmRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

algorithmName

public String algorithmName()

The name of the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

Returns:

The name of the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

algorithmDescription

public String algorithmDescription()

A description of the algorithm.

Returns:

A description of the algorithm.

trainingSpecification

public 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 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 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 Boolean certifyForMarketplace()

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

Returns:

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

toBuilder

public CreateAlgorithmRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAlgorithmRequest.Builder,CreateAlgorithmRequest>

Specified by:

toBuilder in class SageMakerRequest

Returns:

a builder for type T

builder

public static CreateAlgorithmRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.