org.tensorflow.op.core

Class ResourceSparseApplyRMSProp

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.ResourceSparseApplyRMSProp

All Implemented Interfaces:

Op

@Operator
public final class ResourceSparseApplyRMSProp
extends PrimitiveOp

Update '*var' according to the RMSProp algorithm.

Note that in dense implementation of this algorithm, ms and mom will update even if the grad is zero, but in this sparse implementation, ms and mom will not update in iterations during which the grad is zero.

mean_square = decay * mean_square + (1-decay) * gradient ** 2 Delta = learning_rate * gradient / sqrt(mean_square + epsilon)

ms <- rho * ms_{t-1} + (1-rho) * grad * grad mom <- momentum * mom_{t-1} + lr * grad / sqrt(ms + epsilon) var <- var - mom

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
static <T,U extends Number> ResourceSparseApplyRMSProp	create(Scope scope, Operand<?> var, Operand<?> ms, Operand<?> mom, Operand<T> lr, Operand<T> rho, Operand<T> momentum, Operand<T> epsilon, Operand<T> grad, Operand<U> indices, ResourceSparseApplyRMSProp.Options... options) Factory method to create a class to wrap a new ResourceSparseApplyRMSProp operation to the graph.
static ResourceSparseApplyRMSProp.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> ResourceSparseApplyRMSProp create(Scope scope,
                                                                     Operand<?> var,
                                                                     Operand<?> ms,
                                                                     Operand<?> mom,
                                                                     Operand<T> lr,
                                                                     Operand<T> rho,
                                                                     Operand<T> momentum,
                                                                     Operand<T> epsilon,
                                                                     Operand<T> grad,
                                                                     Operand<U> indices,
                                                                     ResourceSparseApplyRMSProp.Options... options)

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

Parameters:

scope - current graph scope

var - Should be from a Variable().

ms - Should be from a Variable().

mom - Should be from a Variable().

lr - Scaling factor. Must be a scalar.

rho - Decay rate. Must be a scalar.

momentum -

epsilon - Ridge term. Must be a scalar.

grad - The gradient.

indices - A vector of indices into the first dimension of var, ms and mom.

options - carries optional attributes values

Returns:

a new instance of ResourceSparseApplyRMSProp

useLocking

public static ResourceSparseApplyRMSProp.Options useLocking(Boolean useLocking)

Parameters:

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