Package 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("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:

  • Method Details

    • 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.

    • supportedEndpointType

      public final RecommendationJobSupportedEndpointType supportedEndpointType()

      The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

      If the service returns an enum value that is not available in the current SDK version, supportedEndpointType will return RecommendationJobSupportedEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from supportedEndpointTypeAsString().

      Returns:
      The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
      See Also:

    • supportedEndpointTypeAsString

      public final String supportedEndpointTypeAsString()

      The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

      If the service returns an enum value that is not available in the current SDK version, supportedEndpointType will return RecommendationJobSupportedEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from supportedEndpointTypeAsString().

      Returns:
      The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
      See Also:

    • dataInputConfig

      public final String dataInputConfig()

      Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.

      Returns:
      Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.

    • hasSupportedResponseMIMETypes

      public final boolean hasSupportedResponseMIMETypes()
      For responses, this returns true if the service returned a value for the SupportedResponseMIMETypes 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.

    • supportedResponseMIMETypes

      public final List<String> supportedResponseMIMETypes()

      The supported MIME types for the output data.

      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 hasSupportedResponseMIMETypes() method.

      Returns:
      The supported MIME types for the output data.

    • toBuilder

      public RecommendationJobContainerConfig.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<RecommendationJobContainerConfig.Builder,RecommendationJobContainerConfig>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.