# tensorflow::ops::ResourceApplyMomentum

`#include <training_ops.h>`

Update '\*var' according to the momentum scheme.

## Summary

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

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

Args:

- scope: A [Scope](https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- 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.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.12/api_docs/cc/struct/tensorflow/ops/resource-apply-momentum/attrs#structtensorflow_1_1ops_1_1_resource_apply_momentum_1_1_attrs`):

- use_locking: 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.
- use_nesterov: 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.

<br />

Returns:

- the created `https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation`

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/ops/resource-apply-momentum#classtensorflow_1_1ops_1_1_resource_apply_momentum_1aa2dffa322d4ed2a027c546db3c2cc9f0(const ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input momentum)` ||
| `https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/ops/resource-apply-momentum#classtensorflow_1_1ops_1_1_resource_apply_momentum_1aaabab8ab9b7e779d819219175b3d01ab(const ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input momentum, const https://www.tensorflow.org/versions/r2.12/api_docs/cc/struct/tensorflow/ops/resource-apply-momentum/attrs#structtensorflow_1_1ops_1_1_resource_apply_momentum_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/ops/resource-apply-momentum#classtensorflow_1_1ops_1_1_resource_apply_momentum_1a9a0f9cac558c342e56f0a2d2dcdecd29` | `https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/ops/resource-apply-momentum#classtensorflow_1_1ops_1_1_resource_apply_momentum_1aad4acd0b17f234ebb7f401abe0b1415b() const ` |   |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/ops/resource-apply-momentum#classtensorflow_1_1ops_1_1_resource_apply_momentum_1a5d328ef958f0a6b9ddd3adc98da54e30(bool x)` | `https://www.tensorflow.org/versions/r2.12/api_docs/cc/struct/tensorflow/ops/resource-apply-momentum/attrs#structtensorflow_1_1ops_1_1_resource_apply_momentum_1_1_attrs` |
| `https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/ops/resource-apply-momentum#classtensorflow_1_1ops_1_1_resource_apply_momentum_1ac1b137ccfdbf8b69e2ffe35db22e7787(bool x)` | `https://www.tensorflow.org/versions/r2.12/api_docs/cc/struct/tensorflow/ops/resource-apply-momentum/attrs#structtensorflow_1_1ops_1_1_resource_apply_momentum_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::ResourceApplyMomentum::Attrs](https://www.tensorflow.org/versions/r2.12/api_docs/cc/struct/tensorflow/ops/resource-apply-momentum/attrs) | Optional attribute setters for [ResourceApplyMomentum](https://www.tensorflow.org/versions/r2.12/api_docs/cc/class/tensorflow/ops/resource-apply-momentum#classtensorflow_1_1ops_1_1_resource_apply_momentum). |

## Public attributes

### operation

```
Operation operation
```

## Public functions

### ResourceApplyMomentum

```
 ResourceApplyMomentum(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input accum,
  ::tensorflow::Input lr,
  ::tensorflow::Input grad,
  ::tensorflow::Input momentum
)
```

### ResourceApplyMomentum

```
 ResourceApplyMomentum(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input accum,
  ::tensorflow::Input lr,
  ::tensorflow::Input grad,
  ::tensorflow::Input momentum,
  const ResourceApplyMomentum::Attrs & attrs
)
```

### operator::tensorflow::Operation

```
 operator::tensorflow::Operation() const 
```

## Public static functions

### UseLocking

```
Attrs UseLocking(
  bool x
)
```

### UseNesterov

```
Attrs UseNesterov(
  bool x
)
```