Gather

public final class Gather

Gather slices from `params` axis `axis` according to `indices`.

`indices` must be an integer tensor of any dimension (usually 0-D or 1-D). Produces an output tensor with shape `params.shape[:axis] + indices.shape[batch_dims:] + params.shape[axis + 1:]` where: 

# Scalar indices (output is rank(params) - 1).
     output[a_0, ..., a_n, b_0, ..., b_n] =
       params[a_0, ..., a_n, indices, b_0, ..., b_n]
 
     # Vector indices (output is rank(params)).
     output[a_0, ..., a_n, i, b_0, ..., b_n] =
       params[a_0, ..., a_n, indices[i], b_0, ..., b_n]
 
     # Higher rank indices (output is rank(params) + rank(indices) - 1).
     output[a_0, ..., a_n, i, ..., j, b_0, ... b_n] =
       params[a_0, ..., a_n, indices[i, ..., j], b_0, ..., b_n]

Note that on CPU, if an out of bound index is found, an error is returned. On GPU, if an out of bound index is found, a 0 is stored in the corresponding output value.

See also `tf.batch_gather` and tf.gather_nd.

Nested Classes

class Gather.Options Optional attributes for Gather  

Constants

String OP_NAME The name of this op, as known by TensorFlow core engine

Public Methods

Output<T>
asOutput()
Returns the symbolic handle of the tensor.
static Gather.Options
batchDims(Long batchDims)
static <T extends TType> Gather<T>
create(Scope scope, Operand<T> params, Operand<? extends TNumber> indices, Operand<? extends TNumber> axis, Options... options)
Factory method to create a class wrapping a new Gather operation.
Output<T>
output()
Values from `params` gathered from indices given by `indices`, with shape `params.shape[:axis] + indices.shape + params.shape[axis + 1:]`.

Inherited Methods

org.tensorflow.op.RawOp
final boolean
equals(Object obj)
final int
hashCode()
Operation
op()
Return this unit of computation as a single Operation.
final String
toString()
boolean
equals(Object arg0)
final Class<?>
getClass()
int
hashCode()
final void
notify()
final void
notifyAll()
String
toString()
final void
wait(long arg0, int arg1)
final void
wait(long arg0)
final void
wait()
org.tensorflow.op.Op
abstract ExecutionEnvironment
env()
Return the execution environment this op was created in.
abstract Operation
op()
Return this unit of computation as a single Operation.
org.tensorflow.Operand
abstract Output<T>
asOutput()
Returns the symbolic handle of the tensor.
abstract T
asTensor()
Returns the tensor at this operand.
abstract Shape
shape()
Returns the (possibly partially known) shape of the tensor referred to by the Output of this operand.
abstract Class<T>
type()
Returns the tensor type of this operand
org.tensorflow.ndarray.Shaped
abstract int
rank()
abstract Shape
shape()
abstract long
size()
Computes and returns the total size of this container, in number of values.

Constants

public static final String OP_NAME

The name of this op, as known by TensorFlow core engine

Constant Value: "GatherV2"

Public Methods

public Output<T> asOutput ()

Returns the symbolic handle of the 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.

public static Gather.Options batchDims (Long batchDims)

public static Gather<T> create (Scope scope, Operand<T> params, Operand<? extends TNumber> indices, Operand<? extends TNumber> axis, Options... options)

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

Parameters
scope current scope
params The tensor from which to gather values. Must be at least rank `axis + 1`.
indices Index tensor. Must be in range `[0, params.shape[axis])`.
axis The axis in `params` to gather `indices` from. Defaults to the first dimension. Supports negative indexes.
options carries optional attributes values
Returns
  • a new instance of Gather

public Output<T> output ()

Values from `params` gathered from indices given by `indices`, with shape `params.shape[:axis] + indices.shape + params.shape[axis + 1:]`.