Class OperationResult

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

The result of a completed training operation. Exactly one member is populated, corresponding to the operation type that was submitted.

See Also:

  • Method Details

    • forward

      public final ForwardResult forward()

      The result from a forward-only pass.

      Returns:
      The result from a forward-only pass.

    • forwardBackward

      public final ForwardBackwardResult forwardBackward()

      The result from a forward and backward pass.

      Returns:
      The result from a forward and backward pass.

    • optimizerStep

      public final OptimizerStepResult optimizerStep()

      The result from an optimizer step.

      Returns:
      The result from an optimizer step.

    • saveWeights

      public final SaveWeightsResult saveWeights()

      The result from saving model weights.

      Returns:
      The result from saving model weights.

    • saveState

      public final SaveStateResult saveState()

      The result from saving full training state.

      Returns:
      The result from saving full training state.

    • loadState

      public final LoadStateResult loadState()

      The result from loading training state.

      Returns:
      The result from loading training state.

    • toBuilder

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

    • builder

      public static OperationResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OperationResult.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 OperationResult fromForward(ForwardResult forward)
      Create an instance of this class with forward() initialized to the given value.

      The result from a forward-only pass.

      Parameters:
      forward - The result from a forward-only pass.

    • fromForward

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

      The result from a forward-only pass.

      Parameters:
      forward - The result from a forward-only pass.

    • fromForwardBackward

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

      The result from a forward and backward pass.

      Parameters:
      forwardBackward - The result from a forward and backward pass.

    • fromForwardBackward

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

      The result from a forward and backward pass.

      Parameters:
      forwardBackward - The result from a forward and backward pass.

    • fromOptimizerStep

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

      The result from an optimizer step.

      Parameters:
      optimizerStep - The result from an optimizer step.

    • fromOptimizerStep

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

      The result from an optimizer step.

      Parameters:
      optimizerStep - The result from an optimizer step.

    • fromSaveWeights

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

      The result from saving model weights.

      Parameters:
      saveWeights - The result from saving model weights.

    • fromSaveWeights

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

      The result from saving model weights.

      Parameters:
      saveWeights - The result from saving model weights.

    • fromSaveState

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

      The result from saving full training state.

      Parameters:
      saveState - The result from saving full training state.

    • fromSaveState

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

      The result from saving full training state.

      Parameters:
      saveState - The result from saving full training state.

    • fromLoadState

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

      The result from loading training state.

      Parameters:
      loadState - The result from loading training state.

    • fromLoadState

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

      The result from loading training state.

      Parameters:
      loadState - The result from loading training state.

    • type

      public OperationResult.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 OperationResult.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 OperationResult.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.