software.amazon.awssdk.services.sagemaker.model

Class RecommendationJobContainerConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.RecommendationJobContainerConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RecommendationJobContainerConfig.Builder,RecommendationJobContainerConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class RecommendationJobContainerConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RecommendationJobContainerConfig.Builder,RecommendationJobContainerConfig>

Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecommendationJobContainerConfig.Builder

Method Summary

Modifier and Type	Method and Description
static RecommendationJobContainerConfig.Builder	builder()
String	domain() The machine learning domain of the model and its components.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	framework() The machine learning framework of the container image.
String	frameworkVersion() The framework version of the container image.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSupportedInstanceTypes() For responses, this returns true if the service returned a value for the SupportedInstanceTypes property.
String	nearestModelName() The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.
RecommendationJobPayloadConfig	payloadConfig() Specifies the SamplePayloadUrl and all other sample payload-related fields.
List<SdkField<?>>	sdkFields()
static Class<? extends RecommendationJobContainerConfig.Builder>	serializableBuilderClass()
List<String>	supportedInstanceTypes() A list of the instance types that are used to generate inferences in real-time.
String	task() The machine learning task that the model accomplishes.
RecommendationJobContainerConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

domain

public final String domain()

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

Returns:

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

task

public final String task()

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER

Returns:

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER

framework

public final String framework()

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

Returns:

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

frameworkVersion

public final String frameworkVersion()

The framework version of the container image.

Returns:

The framework version of the container image.

payloadConfig

public final RecommendationJobPayloadConfig payloadConfig()

Specifies the SamplePayloadUrl and all other sample payload-related fields.

Returns:

Specifies the SamplePayloadUrl and all other sample payload-related fields.

nearestModelName

public final String nearestModelName()

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

Returns:

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

hasSupportedInstanceTypes

public final boolean hasSupportedInstanceTypes()

For responses, this returns true if the service returned a value for the SupportedInstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

supportedInstanceTypes

public final List<String> supportedInstanceTypes()

A list of the instance types that are used to generate inferences in real-time.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedInstanceTypes() method.

Returns:

A list of the instance types that are used to generate inferences in real-time.

toBuilder

public RecommendationJobContainerConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecommendationJobContainerConfig.Builder,RecommendationJobContainerConfig>

builder

public static RecommendationJobContainerConfig.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo