# tensorflow::ops::ResourceApplyKerasMomentum

`#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 - lr \* grad var += 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: Scaling factor. Must be a scalar.
- grad: The gradient.
- momentum: Momentum. Must be a scalar.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/resource-apply-keras-momentum/attrs#structtensorflow_1_1ops_1_1_resource_apply_keras_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 + momentum \* accum, so in the end, the var you get is actually var + 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-apply-keras-momentum#classtensorflow_1_1ops_1_1_resource_apply_keras_momentum_1ac7e58311613d0d165a44cc1fba9e5153(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 momentum)` ||
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-apply-keras-momentum#classtensorflow_1_1ops_1_1_resource_apply_keras_momentum_1ac39d343d2b0d0b400490c36c574218bc(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 momentum, const https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/resource-apply-keras-momentum/attrs#structtensorflow_1_1ops_1_1_resource_apply_keras_momentum_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-apply-keras-momentum#classtensorflow_1_1ops_1_1_resource_apply_keras_momentum_1aae1a5eea3a68d79bac0cd6e088e5ea20` | `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-apply-keras-momentum#classtensorflow_1_1ops_1_1_resource_apply_keras_momentum_1a3c4e446369c8fd3251e9f3b66f4dcd99() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-apply-keras-momentum#classtensorflow_1_1ops_1_1_resource_apply_keras_momentum_1aeba0a5e74d532e896644494ed4152e67(bool x)` | `https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/resource-apply-keras-momentum/attrs#structtensorflow_1_1ops_1_1_resource_apply_keras_momentum_1_1_attrs` |
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/resource-apply-keras-momentum#classtensorflow_1_1ops_1_1_resource_apply_keras_momentum_1a6cac17bd849f55f2f12caf3f2d78ea85(bool x)` | `https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/resource-apply-keras-momentum/attrs#structtensorflow_1_1ops_1_1_resource_apply_keras_momentum_1_1_attrs` |

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

## Public attributes

### operation

```
Operation operation
```

## Public functions

### ResourceApplyKerasMomentum

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

### ResourceApplyKerasMomentum

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

### operator::tensorflow::Operation

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

## Public static functions

### UseLocking

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

### UseNesterov

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