org.tensorflow.op.core

Class ResourceSparseApplyFtrl

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.ResourceSparseApplyFtrl

All Implemented Interfaces:

Op

@Operator
public final class ResourceSparseApplyFtrl
extends PrimitiveOp

Update relevant entries in '*var' according to the Ftrl-proximal scheme.

That is for rows we have grad for, we update var, accum and linear as follows: accum_new = accum + grad * grad linear += grad + (accum_new^(-lr_power) - accum^(-lr_power)) / lr * var quadratic = 1.0 / (accum_new^(lr_power) * lr) + 2 * l2 var = (sign(linear) * l1 - linear) / quadratic if |linear| > l1 else 0.0 accum = accum_new

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
static <T,U extends Number> ResourceSparseApplyFtrl	create(Scope scope, Operand<?> var, Operand<?> accum, Operand<?> linear, Operand<T> grad, Operand<U> indices, Operand<T> lr, Operand<T> l1, Operand<T> l2, Operand<T> lrPower, ResourceSparseApplyFtrl.Options... options) Factory method to create a class to wrap a new ResourceSparseApplyFtrl operation to the graph.
static ResourceSparseApplyFtrl.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> ResourceSparseApplyFtrl create(Scope scope,
                                                                  Operand<?> var,
                                                                  Operand<?> accum,
                                                                  Operand<?> linear,
                                                                  Operand<T> grad,
                                                                  Operand<U> indices,
                                                                  Operand<T> lr,
                                                                  Operand<T> l1,
                                                                  Operand<T> l2,
                                                                  Operand<T> lrPower,
                                                                  ResourceSparseApplyFtrl.Options... options)

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

Parameters:

scope - current graph scope

var - Should be from a Variable().

accum - Should be from a Variable().

linear - Should be from a Variable().

grad - The gradient.

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

lr - Scaling factor. Must be a scalar.

l1 - L1 regularization. Must be a scalar.

l2 - L2 regularization. Must be a scalar.

lrPower - Scaling factor. Must be a scalar.

options - carries optional attributes values

Returns:

a new instance of ResourceSparseApplyFtrl

useLocking

public static ResourceSparseApplyFtrl.Options useLocking(Boolean useLocking)

Parameters:

useLocking - If `True`, updating of the var and accum tensors will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.