# ResourceApplyKerasMomentum

public final class **ResourceApplyKerasMomentum** Update '\*var' according to the momentum scheme.


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


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

<br />

<br />

### Nested Classes

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

### Public Methods

|---|---|
| static \<T\> [ResourceApplyKerasMomentum](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyKerasMomentum) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyKerasMomentum#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<?>,%20org.tensorflow.Operand<?>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.op.core.ResourceApplyKerasMomentum.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)\<?\> accum, [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\> grad, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> momentum, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyKerasMomentum.Options) options) Factory method to create a class wrapping a new ResourceApplyKerasMomentum operation. |
| static [ResourceApplyKerasMomentum.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyKerasMomentum.Options) | [useLocking](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyKerasMomentum#useLocking(java.lang.Boolean))(Boolean useLocking) |
| static [ResourceApplyKerasMomentum.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyKerasMomentum.Options) | [useNesterov](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyKerasMomentum#useNesterov(java.lang.Boolean))(Boolean useNesterov) |

### 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 [ResourceApplyKerasMomentum](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyKerasMomentum)
**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)\<?\> accum, [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\> grad, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> momentum, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ResourceApplyKerasMomentum.Options) options)

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

##### Parameters

| scope | current 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 ResourceApplyKerasMomentum

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

<br />

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

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

<br />

##### Parameters

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