org.tensorflow.op.core

Class SparseMatMul

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.SparseMatMul

All Implemented Interfaces:

Op, Operand<Float>

@Operator
public final class SparseMatMul
extends PrimitiveOp
implements Operand<Float>

Multiply matrix "a" by matrix "b".

The inputs must be two-dimensional matrices and the inner dimension of "a" must match the outer dimension of "b". Both "a" and "b" must be `Tensor`s not `SparseTensor`s. This op is optimized for the case where at least one of "a" or "b" is sparse, in the sense that they have a large proportion of zero values. The breakeven for using this versus a dense matrix multiply on one platform was 30% zero values in the sparse matrix.

The gradient computation of this operation will only take advantage of sparsity in the input gradient when that gradient comes from a Relu.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
static SparseMatMul.Options	aIsSparse(Boolean aIsSparse)
Output<Float>	asOutput() Returns the symbolic handle of a tensor.
static SparseMatMul.Options	bIsSparse(Boolean bIsSparse)
static <T extends Number,U extends Number> SparseMatMul	create(Scope scope, Operand<T> a, Operand<U> b, SparseMatMul.Options... options) Factory method to create a class to wrap a new SparseMatMul operation to the graph.
Output<Float>	product()
static SparseMatMul.Options	transposeA(Boolean transposeA)
static SparseMatMul.Options	transposeB(Boolean transposeB)

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 extends Number,U extends Number> SparseMatMul create(Scope scope,
                                                                      Operand<T> a,
                                                                      Operand<U> b,
                                                                      SparseMatMul.Options... options)

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

Parameters:

scope - current graph scope

a -

b -

options - carries optional attributes values

Returns:

a new instance of SparseMatMul

transposeA

public static SparseMatMul.Options transposeA(Boolean transposeA)

Parameters:

transposeA -

transposeB

public static SparseMatMul.Options transposeB(Boolean transposeB)

Parameters:

transposeB -

aIsSparse

public static SparseMatMul.Options aIsSparse(Boolean aIsSparse)

Parameters:

aIsSparse -

bIsSparse

public static SparseMatMul.Options bIsSparse(Boolean bIsSparse)

Parameters:

bIsSparse -

product

public Output<Float> product()

asOutput

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

See Also:

OperationBuilder.addInput(Output)