# ResourceApplyAdamWithAmsgrad

public final class **ResourceApplyAdamWithAmsgrad** Update '\*var' according to the Adam algorithm.


$$\\text{lr}_t := \\mathrm{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$$
$$\\hat{v}_t := max{\\hat{v}_{t-1}, v_t}$$
$$\\text{variable} := \\text{variable} - \\text{lr}_t \* m_t / (\\sqrt{\\hat{v}_t} + \\epsilon)$$

<br />

### Nested Classes

|---|---|---|---|
| class | [ResourceApplyAdamWithAmsgrad.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad.Options) || Optional attributes for `https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad` |

### Public Methods

|---|---|
| static \<T\> [ResourceApplyAdamWithAmsgrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<?>,%20org.tensorflow.Operand<?>,%20org.tensorflow.Operand<?>,%20org.tensorflow.Operand<?>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.op.core.ResourceApplyAdamWithAmsgrad.Options...))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> var, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> m, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> v, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> vhat, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> beta1Power, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> beta2Power, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> lr, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> beta1, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> beta2, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> epsilon, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> grad, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad.Options) options) Factory method to create a class wrapping a new ResourceApplyAdamWithAmsgrad operation. |
| static [ResourceApplyAdamWithAmsgrad.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad.Options) | [useLocking](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad#useLocking(java.lang.Boolean))(Boolean useLocking) |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| boolean | equals(Object arg0) |
| final Class\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| String | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public static [ResourceApplyAdamWithAmsgrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad)
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> var, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> m, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> v, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> vhat, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> beta1Power, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> beta2Power, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> lr, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> beta1, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> beta2, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> epsilon, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> grad, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad.Options) options)

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

##### Parameters

| scope | current scope |
| var | Should be from a Variable(). |
| m | Should be from a Variable(). |
| v | Should be from a Variable(). |
| vhat | 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 ResourceApplyAdamWithAmsgrad

#### public static [ResourceApplyAdamWithAmsgrad.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyAdamWithAmsgrad.Options)
**useLocking**
(Boolean useLocking)

<br />

##### 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. |
|---|---|