Interface ForwardBackwardResult.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ForwardBackwardResult.Builder,ForwardBackwardResult>, SdkBuilder<ForwardBackwardResult.Builder,ForwardBackwardResult>, SdkPojo

Enclosing class:

ForwardBackwardResult

@Mutable
@NotThreadSafe
public static interface ForwardBackwardResult.Builder
extends SdkPojo, CopyableBuilder<ForwardBackwardResult.Builder,ForwardBackwardResult>

Method Summary

Modifier and Type	Method	Description
ForwardBackwardResult.Builder	lossFnOutputs(Collection<? extends Map<String,TensorData>> lossFnOutputs)	The loss function output tensors, keyed by name.
ForwardBackwardResult.Builder	lossFnOutputs(Map<String,TensorData>... lossFnOutputs)	The loss function output tensors, keyed by name.
ForwardBackwardResult.Builder	lossFnOutputType(String lossFnOutputType)	The data type of the loss function output tensors.
ForwardBackwardResult.Builder	metrics(Map<String,Double> metrics)	The training metrics emitted by the engine, such as loss values.
default ForwardBackwardResult.Builder	tokenUsage(Consumer<TrainingTokenUsage.Builder> tokenUsage)	The token usage statistics for metering.
ForwardBackwardResult.Builder	tokenUsage(TrainingTokenUsage tokenUsage)	The token usage statistics for metering.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

lossFnOutputType

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

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

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

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

ForwardBackwardResult.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 ForwardBackwardResult.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:

• tokenUsage(TrainingTokenUsage)