org.tensorflow.op.core

Class Svd<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

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

Type Parameters:

T - data type for s() output

All Implemented Interfaces:

Op

@Operator
public final class Svd<T>
extends PrimitiveOp

Computes the singular value decompositions of one or more matrices.

Computes the SVD of each inner matrix in `input` such that `input[..., :, :] = u[..., :, :] * diag(s[..., :, :]) * transpose(v[..., :, :])`

 # a is a tensor containing a batch of matrices.
 # s is a tensor of singular values for each matrix.
 # u is the tensor containing of left singular vectors for each matrix.
 # v is the tensor containing of right singular vectors for each matrix.
 s, u, v = svd(a)
 s, _, _ = svd(a, compute_uv=False)
 

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
static Svd.Options	computeUv(Boolean computeUv)
static <T> Svd<T>	create(Scope scope, Operand<T> input, Svd.Options... options) Factory method to create a class to wrap a new Svd operation to the graph.
static Svd.Options	fullMatrices(Boolean fullMatrices)
Output<T>	s() Singular values.
Output<T>	u() Left singular vectors.
Output<T>	v() Left singular vectors.

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> Svd<T> create(Scope scope,
                                Operand<T> input,
                                Svd.Options... options)

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

Parameters:

scope - current graph scope

input - A tensor of shape `[..., M, N]` whose inner-most 2 dimensions form matrices of size `[M, N]`. Let `P` be the minimum of `M` and `N`.

options - carries optional attributes values

Returns:

a new instance of Svd

computeUv

public static Svd.Options computeUv(Boolean computeUv)

Parameters:

computeUv - If true, left and right singular vectors will be computed and returned in `u` and `v`, respectively. If false, `u` and `v` are not set and should never referenced.

fullMatrices

public static Svd.Options fullMatrices(Boolean fullMatrices)

Parameters:

fullMatrices - If true, compute full-sized `u` and `v`. If false (the default), compute only the leading `P` singular vectors. Ignored if `compute_uv` is `False`.

s

public Output<T> s()

Singular values. Shape is `[..., P]`.

u

public Output<T> u()

Left singular vectors. If `full_matrices` is `False` then shape is `[..., M, P]`; if `full_matrices` is `True` then shape is `[..., M, M]`. Undefined if `compute_uv` is `False`.

v

public Output<T> v()

Left singular vectors. If `full_matrices` is `False` then shape is `[..., N, P]`. If `full_matrices` is `True` then shape is `[..., N, N]`. Undefined if `compute_uv` is false.