Class OperationConfig

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

The configuration for a training operation. Exactly one member must be set to specify the operation type and its parameters.

See Also:

  • Method Details

    • forward

      public final ForwardConfig forward()

      The configuration for a forward-only pass through the model without gradient computation.

      Returns:
      The configuration for a forward-only pass through the model without gradient computation.

    • forwardBackward

      public final ForwardBackwardConfig forwardBackward()

      The configuration for a forward and backward pass that computes gradients.

      Returns:
      The configuration for a forward and backward pass that computes gradients.

    • optimizerStep

      public final OptimizerStepConfig optimizerStep()

      The configuration for an optimizer step that updates model weights using accumulated gradients.

      Returns:
      The configuration for an optimizer step that updates model weights using accumulated gradients.

    • saveWeights

      public final SaveWeightsConfig saveWeights()

      The configuration for saving model weights as a checkpoint.

      Returns:
      The configuration for saving model weights as a checkpoint.

    • saveState

      public final SaveStateConfig saveState()

      The configuration for saving full training state, including model weights and optimizer state.

      Returns:
      The configuration for saving full training state, including model weights and optimizer state.

    • loadState

      public final LoadStateConfig loadState()

      The configuration for loading training state from a previously saved checkpoint.

      Returns:
      The configuration for loading training state from a previously saved checkpoint.

    • toBuilder

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

    • builder

      public static OperationConfig.Builder builder()

    • serializableBuilderClass

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

    • fromForward

      public static OperationConfig fromForward(ForwardConfig forward)
      Create an instance of this class with forward() initialized to the given value.

      The configuration for a forward-only pass through the model without gradient computation.

      Parameters:
      forward - The configuration for a forward-only pass through the model without gradient computation.

    • fromForward

      public static OperationConfig fromForward(Consumer<ForwardConfig.Builder> forward)
      Create an instance of this class with forward() initialized to the given value.

      The configuration for a forward-only pass through the model without gradient computation.

      Parameters:
      forward - The configuration for a forward-only pass through the model without gradient computation.

    • fromForwardBackward

      public static OperationConfig fromForwardBackward(ForwardBackwardConfig forwardBackward)
      Create an instance of this class with forwardBackward() initialized to the given value.

      The configuration for a forward and backward pass that computes gradients.

      Parameters:
      forwardBackward - The configuration for a forward and backward pass that computes gradients.

    • fromForwardBackward

      public static OperationConfig fromForwardBackward(Consumer<ForwardBackwardConfig.Builder> forwardBackward)
      Create an instance of this class with forwardBackward() initialized to the given value.

      The configuration for a forward and backward pass that computes gradients.

      Parameters:
      forwardBackward - The configuration for a forward and backward pass that computes gradients.

    • fromOptimizerStep

      public static OperationConfig fromOptimizerStep(OptimizerStepConfig optimizerStep)
      Create an instance of this class with optimizerStep() initialized to the given value.

      The configuration for an optimizer step that updates model weights using accumulated gradients.

      Parameters:
      optimizerStep - The configuration for an optimizer step that updates model weights using accumulated gradients.

    • fromOptimizerStep

      public static OperationConfig fromOptimizerStep(Consumer<OptimizerStepConfig.Builder> optimizerStep)
      Create an instance of this class with optimizerStep() initialized to the given value.

      The configuration for an optimizer step that updates model weights using accumulated gradients.

      Parameters:
      optimizerStep - The configuration for an optimizer step that updates model weights using accumulated gradients.

    • fromSaveWeights

      public static OperationConfig fromSaveWeights(SaveWeightsConfig saveWeights)
      Create an instance of this class with saveWeights() initialized to the given value.

      The configuration for saving model weights as a checkpoint.

      Parameters:
      saveWeights - The configuration for saving model weights as a checkpoint.

    • fromSaveWeights

      public static OperationConfig fromSaveWeights(Consumer<SaveWeightsConfig.Builder> saveWeights)
      Create an instance of this class with saveWeights() initialized to the given value.

      The configuration for saving model weights as a checkpoint.

      Parameters:
      saveWeights - The configuration for saving model weights as a checkpoint.

    • fromSaveState

      public static OperationConfig fromSaveState(SaveStateConfig saveState)
      Create an instance of this class with saveState() initialized to the given value.

      The configuration for saving full training state, including model weights and optimizer state.

      Parameters:
      saveState - The configuration for saving full training state, including model weights and optimizer state.

    • fromSaveState

      public static OperationConfig fromSaveState(Consumer<SaveStateConfig.Builder> saveState)
      Create an instance of this class with saveState() initialized to the given value.

      The configuration for saving full training state, including model weights and optimizer state.

      Parameters:
      saveState - The configuration for saving full training state, including model weights and optimizer state.

    • fromLoadState

      public static OperationConfig fromLoadState(LoadStateConfig loadState)
      Create an instance of this class with loadState() initialized to the given value.

      The configuration for loading training state from a previously saved checkpoint.

      Parameters:
      loadState - The configuration for loading training state from a previously saved checkpoint.

    • fromLoadState

      public static OperationConfig fromLoadState(Consumer<LoadStateConfig.Builder> loadState)
      Create an instance of this class with loadState() initialized to the given value.

      The configuration for loading training state from a previously saved checkpoint.

      Parameters:
      loadState - The configuration for loading training state from a previously saved checkpoint.

    • type

      public OperationConfig.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be OperationConfig.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be OperationConfig.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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