org.tensorflow.op.train

Class ResourceApplyFtrl

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.train.ResourceApplyFtrl

All Implemented Interfaces:

Op

@Operator(group="train")
public final class ResourceApplyFtrl
extends PrimitiveOp

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

grad_with_shrinkage = grad + 2 * l2_shrinkage * var accum_new = accum + grad_with_shrinkage * grad_with_shrinkage linear += grad_with_shrinkage + (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	ResourceApplyFtrl.Options Optional attributes for ResourceApplyFtrl

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
static <T> ResourceApplyFtrl	create(Scope scope, Operand<?> var, Operand<?> accum, Operand<?> linear, Operand<T> grad, Operand<T> lr, Operand<T> l1, Operand<T> l2, Operand<T> l2Shrinkage, Operand<T> lrPower, ResourceApplyFtrl.Options... options) Factory method to create a class wrapping a new ResourceApplyFtrl operation.
static ResourceApplyFtrl.Options	useLocking(Boolean useLocking)

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, op, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static <T> ResourceApplyFtrl create(Scope scope,
                                           Operand<?> var,
                                           Operand<?> accum,
                                           Operand<?> linear,
                                           Operand<T> grad,
                                           Operand<T> lr,
                                           Operand<T> l1,
                                           Operand<T> l2,
                                           Operand<T> l2Shrinkage,
                                           Operand<T> lrPower,
                                           ResourceApplyFtrl.Options... options)

Factory method to create a class wrapping a new ResourceApplyFtrl operation.

Parameters:

scope - current scope

var - Should be from a Variable().

accum - Should be from a Variable().

linear - Should be from a Variable().

grad - The gradient.

lr - Scaling factor. Must be a scalar.

l1 - L1 regulariation. Must be a scalar.

l2 - L2 shrinkage regulariation. Must be a scalar.

l2Shrinkage -

lrPower - Scaling factor. Must be a scalar.

options - carries optional attributes values

Returns:

a new instance of ResourceApplyFtrl

useLocking

public static ResourceApplyFtrl.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.