AddManySparseToTensorsMap

public final class AddManySparseToTensorsMap

Add an `N`-minibatch `SparseTensor` to a `SparseTensorsMap`, return `N` handles.

A `SparseTensor` of rank `R` is represented by three tensors: `sparse_indices`, `sparse_values`, and `sparse_shape`, where

sparse_indices.shape[1] == sparse_shape.shape[0] == R

An `N`-minibatch of `SparseTensor` objects is represented as a `SparseTensor` having a first `sparse_indices` column taking values between `[0, N)`, where the minibatch size `N == sparse_shape[0]`.

The input `SparseTensor` must have rank `R` greater than 1, and the first dimension is treated as the minibatch dimension. Elements of the `SparseTensor` must be sorted in increasing order of this first dimension. The stored `SparseTensor` objects pointed to by each row of the output `sparse_handles` will have rank `R-1`.

The `SparseTensor` values can then be read out as part of a minibatch by passing the given keys as vector elements to `TakeManySparseFromTensorsMap`. To ensure the correct `SparseTensorsMap` is accessed, ensure that the same `container` and `shared_name` are passed to that Op. If no `shared_name` is provided here, instead use the name of the Operation created by calling `sparse.AddManySparseToTensorsMap` as the `shared_name` passed to `TakeManySparseFromTensorsMap`. Ensure the Operations are colocated.

Nested Classes

class AddManySparseToTensorsMap.Options Optional attributes for AddManySparseToTensorsMap

Constants

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

Public Methods

Output<TInt64>	asOutput() Returns the symbolic handle of the tensor.
static AddManySparseToTensorsMap.Options	container(String container)
static AddManySparseToTensorsMap	create(Scope scope, Operand<TInt64> sparseIndices, Operand<? extends TType> sparseValues, Operand<TInt64> sparseShape, Options... options) Factory method to create a class wrapping a new AddManySparseToTensorsMap operation.
static AddManySparseToTensorsMap.Options	sharedName(String sharedName)
Output<TInt64>	sparseHandles() 1-D.

Inherited Methods

From class 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()

From class java.lang.Object

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()

From interface 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`.

From interface org.tensorflow.Operand

abstract Output<TInt64>	asOutput() Returns the symbolic handle of the tensor.
abstract TInt64	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<TInt64>	type() Returns the tensor type of this operand

From interface 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: "AddManySparseToTensorsMap"

Public Methods

public Output<TInt64> 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 AddManySparseToTensorsMap.Options container (String container)

Parameters

container	The container name for the `SparseTensorsMap` created by this op.

public static AddManySparseToTensorsMap create (Scope scope, Operand<TInt64> sparseIndices, Operand<? extends TType> sparseValues, Operand<TInt64> sparseShape, Options... options)

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

Parameters

scope	current scope
sparseIndices	2-D. The `indices` of the minibatch `SparseTensor`. `sparse_indices[:, 0]` must be ordered values in `[0, N)`.
sparseValues	1-D. The `values` of the minibatch `SparseTensor`.
sparseShape	1-D. The `shape` of the minibatch `SparseTensor`. The minibatch size `N == sparse_shape[0]`.
options	carries optional attributes values

Returns

a new instance of AddManySparseToTensorsMap

public static AddManySparseToTensorsMap.Options sharedName (String sharedName)

Parameters

sharedName	The shared name for the `SparseTensorsMap` created by this op. If blank, the new Operation's unique name is used.

public Output<TInt64> sparseHandles ()

1-D. The handles of the `SparseTensor` now stored in the `SparseTensorsMap`. Shape: `[N]`.