AddSparseToTensorsMap

public final class AddSparseToTensorsMap

Add a `SparseTensor` to a `SparseTensorsMap` return its handle.

A `SparseTensor` is represented by three tensors: `sparse_indices`, `sparse_values`, and `sparse_shape`.

This operator takes the given `SparseTensor` and adds it to a container object (a `SparseTensorsMap`). A unique key within this container is generated in the form of an `int64`, and this is the value that is returned.

The `SparseTensor` can then be read out as part of a minibatch by passing the key as a vector element 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.AddSparseToTensorsMap` as the `shared_name` passed to `TakeManySparseFromTensorsMap`. Ensure the Operations are colocated.

Nested Classes

class AddSparseToTensorsMap.Options Optional attributes for AddSparseToTensorsMap

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 AddSparseToTensorsMap.Options	container(String container)
static AddSparseToTensorsMap	create(Scope scope, Operand<TInt64> sparseIndices, Operand<? extends TType> sparseValues, Operand<TInt64> sparseShape, Options... options) Factory method to create a class wrapping a new AddSparseToTensorsMap operation.
static AddSparseToTensorsMap.Options	sharedName(String sharedName)
Output<TInt64>	sparseHandle() 0-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: "AddSparseToTensorsMap"

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 AddSparseToTensorsMap.Options container (String container)

Parameters

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

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

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

Parameters

scope	current scope
sparseIndices	2-D. The `indices` of the `SparseTensor`.
sparseValues	1-D. The `values` of the `SparseTensor`.
sparseShape	1-D. The `shape` of the `SparseTensor`.
options	carries optional attributes values

Returns

a new instance of AddSparseToTensorsMap

public static AddSparseToTensorsMap.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> sparseHandle ()

0-D. The handle of the `SparseTensor` now stored in the `SparseTensorsMap`.