org.tensorflow.op.core

Class Gather<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

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

Type Parameters:

T - data type for output() output

All Implemented Interfaces:

Op, Operand<T>

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

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

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

     # Scalar indices
     output[:, ..., :] = params[indices, :, ... :]
 
     # Vector indices
     output[i, :, ..., :] = params[indices[i], :, ... :]
 
     # Higher rank indices
     output[i, ..., j, :, ... :] = params[indices[i, ..., j], :, ..., :]
 

If `indices` is a permutation and `len(indices) == params.shape[0]` then this operation will permute `params` accordingly.

`validate_indices`: DEPRECATED. If this operation is assigned to CPU, values in `indices` are always validated to be within range. If assigned to GPU, out-of-bound indices result in safe but unspecified behavior, which may include raising an error.

Nested Class Summary

Nested Classes

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

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> Gather<T>	create(Scope scope, Operand<T> params, Operand<U> indices, Gather.Options... options) Factory method to create a class to wrap a new Gather operation to the graph.
Output<T>	output()
static Gather.Options	validateIndices(Boolean validateIndices)

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, 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> Gather<T> create(Scope scope,
                                                    Operand<T> params,
                                                    Operand<U> indices,
                                                    Gather.Options... options)

Factory method to create a class to wrap a new Gather operation to the graph.

Parameters:

scope - current graph scope

params -

indices -

options - carries optional attributes values

Returns:

a new instance of Gather

validateIndices

public static Gather.Options validateIndices(Boolean validateIndices)

Parameters:

validateIndices -

output

public Output<T> output()

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)