# tensorflow::ops::ApplyAdam Class Reference

# tensorflow::ops::ApplyAdam

`#include <training_ops.h>`

Update '\*var' according to the Adam algorithm.

## Summary

$$\\text{lr}_t := \\mathrm{lr} \\cdot \\frac{\\sqrt{1 - \\beta_2\^t} }{1 - \\beta_1\^t}$$ $$m_t := \\beta_1 \\cdot m_{t-1} + (1 - \\beta_1) \\cdot g$$ $$v_t := \\beta_2 \\cdot v_{t-1} + (1 - \\beta_2) \\cdot g\^2$$ $$\\text{var} := \\begin{cases} \\text{var} - (m_t \\beta_1 + g \\cdot (1 - \\beta_1))\\cdot\\text{lr}_t/(\\sqrt{v_t} + \\epsilon), \&\\text{if use_nesterov}\\\\ \\text{var} - m_t \\cdot \\text{lr}_t /(\\sqrt{v_t} + \\epsilon), \&\\text{otherwise} \\end{cases}$$

Args:

- scope: A [Scope](https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- var: Should be from a Variable().
- m: Should be from a Variable().
- v: Should be from a Variable().
- beta1_power: Must be a scalar.
- beta2_power: Must be a scalar.
- lr: Scaling factor. Must be a scalar.
- beta1: Momentum factor. Must be a scalar.
- beta2: Momentum factor. Must be a scalar.
- epsilon: Ridge term. Must be a scalar.
- grad: The gradient.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.7/api_docs/cc/struct/tensorflow/ops/apply-adam/attrs#structtensorflow_1_1ops_1_1_apply_adam_1_1_attrs`):

- use_locking: If `True`, updating of the var, m, and v tensors will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
- use_nesterov: If `True`, uses the nesterov update.

<br />

Returns:

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

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam_1a63f38ab9210b19bbb905e9d494fd0d7c(const ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input m, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input v, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta1_power, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta2_power, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta1, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta2, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input epsilon, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad)` ||
| `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam_1a23c9c116f231e976487216fbf1d880dd(const ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input m, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input v, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta1_power, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta2_power, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta1, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta2, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input epsilon, ::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, const https://www.tensorflow.org/versions/r2.7/api_docs/cc/struct/tensorflow/ops/apply-adam/attrs#structtensorflow_1_1ops_1_1_apply_adam_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam_1a56261a4d240b654e6a61c42931d3b847` | `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |
| `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam_1a51b86c03755b5fa8584c9228a13594d2` | `::https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam_1aca5ba972ba714c19db3728d2dab29a8e() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam_1a8e17d2267864bd25f3ab523a287abb8a() const ` |   |
| `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam_1a596890f0d578e64a6f55540e249ca5c8() const ` |   |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam_1adf5062f34d44b504f428d128fcfecf94(bool x)` | `https://www.tensorflow.org/versions/r2.7/api_docs/cc/struct/tensorflow/ops/apply-adam/attrs#structtensorflow_1_1ops_1_1_apply_adam_1_1_attrs` |
| `https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam_1ae368b25e083d00d0d74551be052064c3(bool x)` | `https://www.tensorflow.org/versions/r2.7/api_docs/cc/struct/tensorflow/ops/apply-adam/attrs#structtensorflow_1_1ops_1_1_apply_adam_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::ApplyAdam::Attrs](https://www.tensorflow.org/versions/r2.7/api_docs/cc/struct/tensorflow/ops/apply-adam/attrs) | Optional attribute setters for [ApplyAdam](https://www.tensorflow.org/versions/r2.7/api_docs/cc/class/tensorflow/ops/apply-adam#classtensorflow_1_1ops_1_1_apply_adam). |

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### ApplyAdam

```
 ApplyAdam(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input m,
  ::tensorflow::Input v,
  ::tensorflow::Input beta1_power,
  ::tensorflow::Input beta2_power,
  ::tensorflow::Input lr,
  ::tensorflow::Input beta1,
  ::tensorflow::Input beta2,
  ::tensorflow::Input epsilon,
  ::tensorflow::Input grad
)
```

### ApplyAdam

```
 ApplyAdam(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input m,
  ::tensorflow::Input v,
  ::tensorflow::Input beta1_power,
  ::tensorflow::Input beta2_power,
  ::tensorflow::Input lr,
  ::tensorflow::Input beta1,
  ::tensorflow::Input beta2,
  ::tensorflow::Input epsilon,
  ::tensorflow::Input grad,
  const ApplyAdam::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
)
```