# tensorflow::ops::ResourceApplyAdam Class Reference

# tensorflow::
ops::
ResourceApplyAdam

`
#include <training_ops.h>
`


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

## Summary


$${lr}_t := {learning_rate} \* {1 - \^t} / (1 - \^t)$$ $$m_t := \* m_{t-1} + (1 - ) \* g$$ $$v_t := \* v_{t-1} + (1 - ) \* g \* g$$ $${variable} := {variable} - {lr}_t \* m_t / ({v_t} + )$$

<br />


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().
- 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.5/api_docs/cc/struct/tensorflow/ops/resource-apply-adam/attrs#structtensorflow_1_1ops_1_1_resource_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:

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

<br />

| ### Constructors and Destructors ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-adam#classtensorflow_1_1ops_1_1_resource_apply_adam_1ac795afbdb2b0b71ee2d2de82cc60f117 (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 m, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input v, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta1_power, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta2_power, :: 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 beta1, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta2, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input epsilon, :: 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/ops/resource-apply-adam#classtensorflow_1_1ops_1_1_resource_apply_adam_1ab1142d9fee53446380bed6cf6ffc3d16 (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 m, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input v, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta1_power, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta2_power, :: 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 beta1, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta2, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input epsilon, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, const https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-adam/attrs#structtensorflow_1_1ops_1_1_resource_apply_adam_1_1_attrs & attrs) ` ||

| ### Public attributes ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-adam#classtensorflow_1_1ops_1_1_resource_apply_adam_1aabbba4cd6d62166c77e9ac3da3caa0bd ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation ` |

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

| ### Public static functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-adam#classtensorflow_1_1ops_1_1_resource_apply_adam_1a608016b3becbe65a6899bb3c0d4c1cf4 (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-adam/attrs#structtensorflow_1_1ops_1_1_resource_apply_adam_1_1_attrs ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-adam#classtensorflow_1_1ops_1_1_resource_apply_adam_1aa7ac09e230c73e3ee869c80a9eef764d (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-adam/attrs#structtensorflow_1_1ops_1_1_resource_apply_adam_1_1_attrs ` |

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

## Public attributes

### operation

```
Operation operation
```

## Public functions

### ResourceApplyAdam

```
 ResourceApplyAdam(
  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
)
```

### ResourceApplyAdam

```
 ResourceApplyAdam(
  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 ResourceApplyAdam::Attrs & attrs
)
```

### operator::tensorflow::Operation

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

## Public static functions

### UseLocking

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

### UseNesterov

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