Interface ForwardResult.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ForwardResult.Builder,ForwardResult>, SdkBuilder<ForwardResult.Builder,ForwardResult>, SdkPojo
Enclosing class:
ForwardResult
@Mutable @NotThreadSafe public static interface ForwardResult.Builder extends SdkPojo, CopyableBuilder<ForwardResult.Builder,ForwardResult>

  • Method Details

    • lossFnOutputType

      ForwardResult.Builder lossFnOutputType(String lossFnOutputType)

      The data type of the loss function output tensors.

      Parameters:
      lossFnOutputType - The data type of the loss function output tensors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lossFnOutputs

      ForwardResult.Builder lossFnOutputs(Collection<? extends Map<String,TensorData>> lossFnOutputs)

      The loss function output tensors, keyed by name.

      Parameters:
      lossFnOutputs - The loss function output tensors, keyed by name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lossFnOutputs

      ForwardResult.Builder lossFnOutputs(Map<String,TensorData>... lossFnOutputs)

      The loss function output tensors, keyed by name.

      Parameters:
      lossFnOutputs - The loss function output tensors, keyed by name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metrics

      ForwardResult.Builder metrics(Map<String,Double> metrics)

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

      Parameters:
      metrics - The training metrics emitted by the engine, such as loss values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tokenUsage

      ForwardResult.Builder tokenUsage(TrainingTokenUsage tokenUsage)

      The token usage statistics for metering.

      Parameters:
      tokenUsage - The token usage statistics for metering.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tokenUsage

      default ForwardResult.Builder tokenUsage(Consumer<TrainingTokenUsage.Builder> tokenUsage)

      The token usage statistics for metering.

      This is a convenience method that creates an instance of the TrainingTokenUsage.Builder avoiding the need to create one manually via TrainingTokenUsage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tokenUsage(TrainingTokenUsage).

      Parameters:
      tokenUsage - a consumer that will call methods on TrainingTokenUsage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: