org.tensorflow.op.sparse

Class AddSparseToTensorsMap

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.sparse.AddSparseToTensorsMap

All Implemented Interfaces:

Op, Operand<Long>

@Operator(group="sparse")
public final class AddSparseToTensorsMap
extends PrimitiveOp
implements Operand<Long>

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 Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
Output<Long>	asOutput() Returns the symbolic handle of a tensor.
static AddSparseToTensorsMap.Options	container(String container)
static <T> AddSparseToTensorsMap	create(Scope scope, Operand<Long> sparseIndices, Operand<T> sparseValues, Operand<Long> sparseShape, AddSparseToTensorsMap.Options... options) Factory method to create a class wrapping a new AddSparseToTensorsMap operation.
static AddSparseToTensorsMap.Options	sharedName(String sharedName)
Output<Long>	sparseHandle() 0-D.

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> AddSparseToTensorsMap create(Scope scope,
                                               Operand<Long> sparseIndices,
                                               Operand<T> sparseValues,
                                               Operand<Long> sparseShape,
                                               AddSparseToTensorsMap.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

container

public static AddSparseToTensorsMap.Options container(String container)

Parameters:

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

sharedName

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.

sparseHandle

public Output<Long> sparseHandle()

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

asOutput

public Output<Long> 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<Long>

See Also:

OperationBuilder.addInput(Output)