# tensorflow::ops::ApplyMomentum Class Reference

# tensorflow::
ops::
ApplyMomentum

`
#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.5/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.5/api_docs/cc/struct/tensorflow/ops/apply-momentum/attrs#structtensorflow_1_1ops_1_1_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:

- `
  https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output
  ` : Same as "var".

<br />

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

| ### Public attributes ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-momentum#classtensorflow_1_1ops_1_1_apply_momentum_1afeb55f0af37f433f53dc62116f0c8bf8 ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-momentum#classtensorflow_1_1ops_1_1_apply_momentum_1adc714468dda0674aca4fa13fea935dcf ` | ` :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output ` |

| ### Public functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-momentum#classtensorflow_1_1ops_1_1_apply_momentum_1ab1bc1796db29a0f1d286b5270faa76c0 () const ` | ` ::tensorflow::Node * ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-momentum#classtensorflow_1_1ops_1_1_apply_momentum_1a9d4224bb92da65979b204769d7359662 () const ` | ` ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-momentum#classtensorflow_1_1ops_1_1_apply_momentum_1a99975feb13b1eac6b8e4153e04b341bc () const ` | ` ` |

| ### Public static functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-momentum#classtensorflow_1_1ops_1_1_apply_momentum_1a4a0957d092a63a28884f092dfe199e60 (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/apply-momentum/attrs#structtensorflow_1_1ops_1_1_apply_momentum_1_1_attrs ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-momentum#classtensorflow_1_1ops_1_1_apply_momentum_1aafa34ce6f18e9d85f9aa7e5484b54496 (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/apply-momentum/attrs#structtensorflow_1_1ops_1_1_apply_momentum_1_1_attrs ` |

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

## Public attributes

### operation

```
Operation operation
```

### out

```
::tensorflow::Output out
```

## Public functions

### ApplyMomentum

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

### ApplyMomentum

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

### node

```
::tensorflow::Node * node() const 
```

### operator::tensorflow::Input

```
 operator::tensorflow::Input() const 
```

### operator::tensorflow::Output

```
 operator::tensorflow::Output() const 
```

## Public static functions

### UseLocking

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

### UseNesterov

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