org.tensorflow.op.core

Class SparseApplyProximalGradientDescent<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

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

Type Parameters:

T - data type for out() output

All Implemented Interfaces:

Op, Operand<T>

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

Sparse update '*var' as FOBOS algorithm with fixed learning rate.

That is for rows we have grad for, we update var as follows: $$prox_v = var - alpha grad$$ $$var = sign(prox_v)/(1+alphal2) max{|prox_v|-alphal1,0}$$

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
Output<T>	asOutput() Returns the symbolic handle of a tensor.
static <T,U extends Number> SparseApplyProximalGradientDescent<T>	create(Scope scope, Operand<T> var, Operand<T> alpha, Operand<T> l1, Operand<T> l2, Operand<T> grad, Operand<U> indices, SparseApplyProximalGradientDescent.Options... options) Factory method to create a class to wrap a new SparseApplyProximalGradientDescent operation to the graph.
Output<T>	out() Same as "var".
static SparseApplyProximalGradientDescent.Options	useLocking(Boolean useLocking)

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,U extends Number> SparseApplyProximalGradientDescent<T> create(Scope scope,
                                                                                Operand<T> var,
                                                                                Operand<T> alpha,
                                                                                Operand<T> l1,
                                                                                Operand<T> l2,
                                                                                Operand<T> grad,
                                                                                Operand<U> indices,
                                                                                SparseApplyProximalGradientDescent.Options... options)

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

Parameters:

scope - current graph scope

var - Should be from a Variable().

alpha - Scaling factor. Must be a scalar.

l1 - L1 regularization. Must be a scalar.

l2 - L2 regularization. Must be a scalar.

grad - The gradient.

indices - A vector of indices into the first dimension of var and accum.

options - carries optional attributes values

Returns:

a new instance of SparseApplyProximalGradientDescent

useLocking

public static SparseApplyProximalGradientDescent.Options useLocking(Boolean useLocking)

Parameters:

useLocking - If True, the subtraction will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.

out

public Output<T> out()

Same as "var".

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)