Class ForwardResult

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

The result of a forward-only pass through the model.

See Also:

  • Method Details

    • lossFnOutputType

      public final String lossFnOutputType()

      The data type of the loss function output tensors.

      Returns:
      The data type of the loss function output tensors.

    • hasLossFnOutputs

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

    • lossFnOutputs

      public final List<Map<String,TensorData>> lossFnOutputs()

      The loss function output tensors, keyed by name.

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

      Returns:
      The loss function output tensors, keyed by name.

    • hasMetrics

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

    • metrics

      public final Map<String,Double> metrics()

      The training metrics emitted by the engine, such as loss values.

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

      Returns:
      The training metrics emitted by the engine, such as loss values.

    • tokenUsage

      public final TrainingTokenUsage tokenUsage()

      The token usage statistics for metering.

      Returns:
      The token usage statistics for metering.

    • toBuilder

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

    • builder

      public static ForwardResult.Builder builder()

    • serializableBuilderClass

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