org.tensorflow.op.core

Class ResourceApplyMomentum

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.ResourceApplyMomentum

All Implemented Interfaces:

Op

@Operator
public final class ResourceApplyMomentum
extends PrimitiveOp

Update '*var' according to the momentum scheme. Set use_nesterov = True if you

want to use Nesterov momentum.

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
static <T> ResourceApplyMomentum	create(Scope scope, Operand<?> var, Operand<?> accum, Operand<T> lr, Operand<T> grad, Operand<T> momentum, ResourceApplyMomentum.Options... options) Factory method to create a class to wrap a new ResourceApplyMomentum operation to the graph.
static ResourceApplyMomentum.Options	useLocking(Boolean useLocking)
static ResourceApplyMomentum.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> ResourceApplyMomentum create(Scope scope,
                                               Operand<?> var,
                                               Operand<?> accum,
                                               Operand<T> lr,
                                               Operand<T> grad,
                                               Operand<T> momentum,
                                               ResourceApplyMomentum.Options... options)

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

Parameters:

scope - current graph scope

var - Should be from a Variable().

accum - Should be from a Variable().

lr - Scaling factor. Must be a scalar.

grad - The gradient.

momentum - Momentum. Must be a scalar.

options - carries optional attributes values

Returns:

a new instance of ResourceApplyMomentum

useLocking

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