org.tensorflow.op.core

Class ScatterAdd<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.ScatterAdd<T>

Type Parameters:

T - data type for outputRef() output

All Implemented Interfaces:

Op, Operand<T>

@Operator
public final class ScatterAdd<T>
extends PrimitiveOp
implements Operand<T>

Adds sparse updates to a variable reference.

This operation computes

# Scalar indices ref[indices, ...] += updates[...]

# Vector indices (for each i) ref[indices[i], ...] += updates[i, ...]

# High rank indices (for each i, ..., j) ref[indices[i, ..., j], ...] += updates[i, ..., j, ...]

This operation outputs `ref` after the update is done. This makes it easier to chain operations that need to use the reset value.

Duplicate entries are handled correctly: if multiple `indices` reference the same location, their contributions add.

Requires `updates.shape = indices.shape + ref.shape[1:]` or `updates.shape = []`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScatterAdd.Options Optional attributes for ScatterAdd

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
Output<T>	asOutput() Returns the symbolic handle of a tensor.
static <T,U extends Number> ScatterAdd<T>	create(Scope scope, Operand<T> ref, Operand<U> indices, Operand<T> updates, ScatterAdd.Options... options) Factory method to create a class wrapping a new ScatterAdd operation.
Output<T>	outputRef() = Same as `ref`.
static ScatterAdd.Options	useLocking(Boolean useLocking)

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, op, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static <T,U extends Number> ScatterAdd<T> create(Scope scope,
                                                        Operand<T> ref,
                                                        Operand<U> indices,
                                                        Operand<T> updates,
                                                        ScatterAdd.Options... options)

Factory method to create a class wrapping a new ScatterAdd operation.

Parameters:

scope - current scope

ref - Should be from a `Variable` node.

indices - A tensor of indices into the first dimension of `ref`.

updates - A tensor of updated values to add to `ref`.

options - carries optional attributes values

Returns:

a new instance of ScatterAdd

useLocking

public static ScatterAdd.Options useLocking(Boolean useLocking)

Parameters:

useLocking - If True, the addition will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.

outputRef

public Output<T> outputRef()

= Same as `ref`. Returned as a convenience for operations that want to use the updated values after the update is done.

asOutput

public Output<T> asOutput()

Description copied from interface: Operand

Returns the symbolic handle of a tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is used to obtain a symbolic handle that represents the computation of the input.

Specified by:

asOutput in interface Operand<T>

See Also:

OperationBuilder.addInput(Output)