Package org.tensorflow.op.train

Class ResourceApplyAdam

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.train.ResourceApplyAdam

All Implemented Interfaces:

Op

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

Update '*var' according to the Adam algorithm.

$$lr_t := \text{learning\_rate} * \sqrt{1 - beta_2^t} / (1 - beta_1^t)$$ $$m_t := beta_1 * m_{t-1} + (1 - beta_1) * g$$ $$v_t := beta_2 * v_{t-1} + (1 - beta_2) * g * g$$ $$variable := variable - lr_t * m_t / (\sqrt{v_t} + \epsilon)$$

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method	Description
static <T> ResourceApplyAdam	create(Scope scope, Operand<?> var, Operand<?> m, Operand<?> v, Operand<T> beta1Power, Operand<T> beta2Power, Operand<T> lr, Operand<T> beta1, Operand<T> beta2, Operand<T> epsilon, Operand<T> grad, ResourceApplyAdam.Options... options)	Factory method to create a class to wrap a new ResourceApplyAdam operation to the graph.
static ResourceApplyAdam.Options	useLocking(java.lang.Boolean useLocking)
static ResourceApplyAdam.Options	useNesterov(java.lang.Boolean useNesterov)

Methods inherited from class java.lang.Object

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

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, toString

Method Detail

create

public static <T> ResourceApplyAdam create(Scope scope,
                                           Operand<?> var,
                                           Operand<?> m,
                                           Operand<?> v,
                                           Operand<T> beta1Power,
                                           Operand<T> beta2Power,
                                           Operand<T> lr,
                                           Operand<T> beta1,
                                           Operand<T> beta2,
                                           Operand<T> epsilon,
                                           Operand<T> grad,
                                           ResourceApplyAdam.Options... options)

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

Parameters:

scope - current graph scope

var - Should be from a Variable().

m - Should be from a Variable().

v - Should be from a Variable().

beta1Power - Must be a scalar.

beta2Power - Must be a scalar.

lr - Scaling factor. Must be a scalar.

beta1 - Momentum factor. Must be a scalar.

beta2 - Momentum factor. Must be a scalar.

epsilon - Ridge term. Must be a scalar.

grad - The gradient.

options - carries optional attributes values

Returns:

a new instance of ResourceApplyAdam

useLocking

public static ResourceApplyAdam.Options useLocking(java.lang.Boolean useLocking)

Parameters:

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

useNesterov

public static ResourceApplyAdam.Options useNesterov(java.lang.Boolean useNesterov)

Parameters:

useNesterov - If `True`, uses the nesterov update.