org.tensorflow.op.core

Class ResourceSparseApplyMomentum

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.ResourceSparseApplyMomentum

All Implemented Interfaces:

Op

@Operator
public final class ResourceSparseApplyMomentum
extends PrimitiveOp

Update relevant entries in '*var' and '*accum' according to the momentum scheme.

Set use_nesterov = True if you want to use Nesterov momentum.

That is for rows we have grad for, we update var and accum as follows:

accum = accum * momentum + grad var -= lr * accum

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
static <T,U extends Number> ResourceSparseApplyMomentum	create(Scope scope, Operand<?> var, Operand<?> accum, Operand<T> lr, Operand<T> grad, Operand<U> indices, Operand<T> momentum, ResourceSparseApplyMomentum.Options... options) Factory method to create a class to wrap a new ResourceSparseApplyMomentum operation to the graph.
static ResourceSparseApplyMomentum.Options	useLocking(Boolean useLocking)
static ResourceSparseApplyMomentum.Options	useNesterov(Boolean useNesterov)

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> ResourceSparseApplyMomentum create(Scope scope,
                                                                      Operand<?> var,
                                                                      Operand<?> accum,
                                                                      Operand<T> lr,
                                                                      Operand<T> grad,
                                                                      Operand<U> indices,
                                                                      Operand<T> momentum,
                                                                      ResourceSparseApplyMomentum.Options... options)

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

Parameters:

scope - current graph scope

var - Should be from a Variable().

accum - Should be from a Variable().

lr - Learning rate. Must be a scalar.

grad - The gradient.

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

momentum - Momentum. Must be a scalar.

options - carries optional attributes values

Returns:

a new instance of ResourceSparseApplyMomentum

useLocking

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

useNesterov

public static ResourceSparseApplyMomentum.Options useNesterov(Boolean useNesterov)

Parameters:

useNesterov - If `True`, the tensor passed to compute grad will be var - lr * momentum * accum, so in the end, the var you get is actually var - lr * momentum * accum.