org.tensorflow.op.core

Class BatchMatMul<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

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

Type Parameters:

T - data type for output() output

All Implemented Interfaces:

Op, Operand<T>

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

Multiplies slices of two tensors in batches.

Multiplies all slices of `Tensor` `x` and `y` (each slice can be viewed as an element of a batch), and arranges the individual results in a single output tensor of the same batch size. Each of the individual slices can optionally be adjointed (to adjoint a matrix means to transpose and conjugate it) before multiplication by setting the `adj_x` or `adj_y` flag to `True`, which are by default `False`.

The input tensors `x` and `y` are 2-D or higher with shape `[..., r_x, c_x]` and `[..., r_y, c_y]`.

The output tensor is 2-D or higher with shape `[..., r_o, c_o]`, where:

r_o = c_x if adj_x else r_x c_o = r_y if adj_y else c_y

It is computed as:

output[..., :, :] = matrix(x[..., :, :]) * matrix(y[..., :, :])

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
static BatchMatMul.Options	adjX(Boolean adjX)
static BatchMatMul.Options	adjY(Boolean adjY)
Output<T>	asOutput() Returns the symbolic handle of a tensor.
static <T> BatchMatMul<T>	create(Scope scope, Operand<T> x, Operand<T> y, BatchMatMul.Options... options) Factory method to create a class to wrap a new BatchMatMul operation to the graph.
Output<T>	output() 3-D or higher with shape `[..., r_o, c_o]`

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> BatchMatMul<T> create(Scope scope,
                                        Operand<T> x,
                                        Operand<T> y,
                                        BatchMatMul.Options... options)

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

Parameters:

scope - current graph scope

x - 2-D or higher with shape `[..., r_x, c_x]`.

y - 2-D or higher with shape `[..., r_y, c_y]`.

options - carries optional attributes values

Returns:

a new instance of BatchMatMul

adjX

public static BatchMatMul.Options adjX(Boolean adjX)

Parameters:

adjX - If `True`, adjoint the slices of `x`. Defaults to `False`.

adjY

public static BatchMatMul.Options adjY(Boolean adjY)

Parameters:

adjY - If `True`, adjoint the slices of `y`. Defaults to `False`.

output

public Output<T> output()

3-D or higher with shape `[..., r_o, c_o]`

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)