# tensorflow::ops::ApplyAdagrad Class Reference

# tensorflow::ops::ApplyAdagrad

`#include <training_ops.h>`

Update '\*var' according to the adagrad scheme.

## Summary

accum += grad \* grad var -= lr \* grad \* (1 / sqrt(accum))

Arguments:

- scope: A [Scope](https://www.tensorflow.org/versions/r2.4/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.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.4/api_docs/cc/struct/tensorflow/ops/apply-adagrad/attrs#structtensorflow_1_1ops_1_1_apply_adagrad_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.

<br />

Returns:

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

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad_1a119cb4675749a5746ce8598f8793a671(const ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad)` ||
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad_1a251be3569dad2f58e5820e423d32f28c(const ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, const https://www.tensorflow.org/versions/r2.4/api_docs/cc/struct/tensorflow/ops/apply-adagrad/attrs#structtensorflow_1_1ops_1_1_apply_adagrad_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad_1a7e34dfd358db60a1c864ec24b278de1e` | `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad_1a3fe05f28ae9aa48b8351a53fc562e03d` | `::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad_1ac3e8e9b94978a64092adee8ae4836249() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad_1a881551beab3939a976b1a859acc77e89() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad_1a97a0d1b59f2d6bf45ed2281809bfba96() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad_1aebe5e4875477a6e8f3634d4c5c33dba0(bool x)` | `https://www.tensorflow.org/versions/r2.4/api_docs/cc/struct/tensorflow/ops/apply-adagrad/attrs#structtensorflow_1_1ops_1_1_apply_adagrad_1_1_attrs` |
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad_1a412d43f4d6cbb6c10d0e49edf9f256f2(bool x)` | `https://www.tensorflow.org/versions/r2.4/api_docs/cc/struct/tensorflow/ops/apply-adagrad/attrs#structtensorflow_1_1ops_1_1_apply_adagrad_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::ApplyAdagrad::Attrs](https://www.tensorflow.org/versions/r2.4/api_docs/cc/struct/tensorflow/ops/apply-adagrad/attrs) | Optional attribute setters for [ApplyAdagrad](https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/apply-adagrad#classtensorflow_1_1ops_1_1_apply_adagrad). |

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### ApplyAdagrad

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

### ApplyAdagrad

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

### node

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

### operator::tensorflow::Input

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

### operator::tensorflow::Output

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

## Public static functions

### UpdateSlots

```
Attrs UpdateSlots(
  bool x
)
```

### UseLocking

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