# tensorflow::ops::ResourceSparseApplyMomentum

`#include <training_ops.h>`

Update relevant entries in '\*var' and '\*accum' according to the momentum scheme.

## Summary

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

That is for rows we have grad for, we update var and accum as follows:

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

Arguments:

- scope: A [Scope](https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- var: Should be from a Variable().
- accum: Should be from a Variable().
- lr: Learning rate. Must be a scalar.
- grad: The gradient.
- indices: A vector of indices into the first dimension of var and accum.
- momentum: Momentum. Must be a scalar.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-momentum/attrs#structtensorflow_1_1ops_1_1_resource_sparse_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/r1.15/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation`

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-momentum#classtensorflow_1_1ops_1_1_resource_sparse_apply_momentum_1a3b89e9c66e4d0dc308a10134ae6cbebf(const ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input momentum)` ||
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-momentum#classtensorflow_1_1ops_1_1_resource_sparse_apply_momentum_1a7bfac1b224e032491ecc86795f329c8e(const ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input momentum, const https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-momentum/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_momentum_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-momentum#classtensorflow_1_1ops_1_1_resource_sparse_apply_momentum_1a11426b87c209f56e6dcf2292d88add6b` | `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-momentum#classtensorflow_1_1ops_1_1_resource_sparse_apply_momentum_1afbbbd2135b89a2e0cb965142a19a3aaa() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-momentum#classtensorflow_1_1ops_1_1_resource_sparse_apply_momentum_1a4c78145c5e8b7aa22178f1a4d57812ac(bool x)` | `https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-momentum/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_momentum_1_1_attrs` |
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-momentum#classtensorflow_1_1ops_1_1_resource_sparse_apply_momentum_1a433bc4ac6cba2fdad7e05889843770e4(bool x)` | `https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-momentum/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_momentum_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::ResourceSparseApplyMomentum::Attrs](https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-momentum/attrs) | Optional attribute setters for [ResourceSparseApplyMomentum](https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-momentum#classtensorflow_1_1ops_1_1_resource_sparse_apply_momentum). |

## Public attributes

### operation

```
Operation operation
```

## Public functions

### ResourceSparseApplyMomentum

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

### ResourceSparseApplyMomentum

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

### operator::tensorflow::Operation

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

## Public static functions

### UseLocking

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

### UseNesterov

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