Class InferenceComponentComputeResourceRequirements

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.InferenceComponentComputeResourceRequirements
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InferenceComponentComputeResourceRequirements.Builder,InferenceComponentComputeResourceRequirements>
@Generated("software.amazon.awssdk:codegen") public final class InferenceComponentComputeResourceRequirements extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InferenceComponentComputeResourceRequirements.Builder,InferenceComponentComputeResourceRequirements>

Defines the compute resources to allocate to run a model, plus any adapter models, that you assign to an inference component. These resources include CPU cores, accelerators, and memory.

See Also:

  • Method Details

    • numberOfCpuCoresRequired

      public final Float numberOfCpuCoresRequired()

      The number of CPU cores to allocate to run a model that you assign to an inference component.

      Returns:
      The number of CPU cores to allocate to run a model that you assign to an inference component.

    • numberOfAcceleratorDevicesRequired

      public final Float numberOfAcceleratorDevicesRequired()

      The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.

      Returns:
      The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.

    • minMemoryRequiredInMb

      public final Integer minMemoryRequiredInMb()

      The minimum MB of memory to allocate to run a model that you assign to an inference component.

      Returns:
      The minimum MB of memory to allocate to run a model that you assign to an inference component.

    • maxMemoryRequiredInMb

      public final Integer maxMemoryRequiredInMb()

      The maximum MB of memory to allocate to run a model that you assign to an inference component.

      Returns:
      The maximum MB of memory to allocate to run a model that you assign to an inference component.

    • acceleratorPartitionType

      public final String acceleratorPartitionType()

      The accelerator partition profile this inference component occupies; on NVIDIA GPUs this is a Multi-Instance GPU (MIG) profile such as mig-3g.40gb. It must be one of the partition profiles declared in the target endpoint's accelerator partition layout, and when set, NumberOfAcceleratorDevicesRequired must be 1. This field is required when the endpoint's production variant has an accelerator partition layout. For endpoints without a layout, omit this field to place the inference component on a whole accelerator.

      Returns:
      The accelerator partition profile this inference component occupies; on NVIDIA GPUs this is a Multi-Instance GPU (MIG) profile such as mig-3g.40gb. It must be one of the partition profiles declared in the target endpoint's accelerator partition layout, and when set, NumberOfAcceleratorDevicesRequired must be 1. This field is required when the endpoint's production variant has an accelerator partition layout. For endpoints without a layout, omit this field to place the inference component on a whole accelerator.

    • toBuilder

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

    • builder

      public static InferenceComponentComputeResourceRequirements.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InferenceComponentComputeResourceRequirements.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.