# tensorflow::ops::SparseApplyAdagradDA Class Reference

# tensorflow::ops::SparseApplyAdagradDA

`#include <training_ops.h>`

Update entries in '\*var' and '\*accum' according to the proximal adagrad scheme.

## Summary

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().
- gradient_accumulator: Should be from a Variable().
- gradient_squared_accumulator: Should be from a Variable().
- grad: The gradient.
- indices: A vector of indices into the first dimension of var and accum.
- lr: Learning rate. Must be a scalar.
- l1: L1 regularization. Must be a scalar.
- l2: L2 regularization. Must be a scalar.
- global_step: Training step number. Must be a scalar.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.4/api_docs/cc/struct/tensorflow/ops/sparse-apply-adagrad-d-a/attrs#structtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_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/sparse-apply-adagrad-d-a#classtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1afb1971e3dbb0f4a487a6069c9fdb15ee(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 gradient_accumulator, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input gradient_squared_accumulator, ::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/input#classtensorflow_1_1_input indices, ::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 l1, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input global_step)` ||
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/sparse-apply-adagrad-d-a#classtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1a61642fb9a5da48aa72a60bc248dd3e03(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 gradient_accumulator, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input gradient_squared_accumulator, ::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/input#classtensorflow_1_1_input indices, ::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 l1, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2, ::https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input global_step, const https://www.tensorflow.org/versions/r2.4/api_docs/cc/struct/tensorflow/ops/sparse-apply-adagrad-d-a/attrs#structtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/sparse-apply-adagrad-d-a#classtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1a79d811cc083567eda56a62699a3a737c` | `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/sparse-apply-adagrad-d-a#classtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1ae2d982a56df04499e51fd2bcd4d2eaf1` | `::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/sparse-apply-adagrad-d-a#classtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1ade2e4f81a3f15e8fcf846c76a6755f95() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/sparse-apply-adagrad-d-a#classtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1a9eca1ddc2bc2bfeb6b52f0381ded7681() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/sparse-apply-adagrad-d-a#classtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1a2294c61087c20e5f137686b036811953() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.4/api_docs/cc/class/tensorflow/ops/sparse-apply-adagrad-d-a#classtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1a4c35b958f9150ddc168dc9c52e2b743e(bool x)` | `https://www.tensorflow.org/versions/r2.4/api_docs/cc/struct/tensorflow/ops/sparse-apply-adagrad-d-a/attrs#structtensorflow_1_1ops_1_1_sparse_apply_adagrad_d_a_1_1_attrs` |

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

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### SparseApplyAdagradDA

```
 SparseApplyAdagradDA(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input gradient_accumulator,
  ::tensorflow::Input gradient_squared_accumulator,
  ::tensorflow::Input grad,
  ::tensorflow::Input indices,
  ::tensorflow::Input lr,
  ::tensorflow::Input l1,
  ::tensorflow::Input l2,
  ::tensorflow::Input global_step
)
```

### SparseApplyAdagradDA

```
 SparseApplyAdagradDA(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input gradient_accumulator,
  ::tensorflow::Input gradient_squared_accumulator,
  ::tensorflow::Input grad,
  ::tensorflow::Input indices,
  ::tensorflow::Input lr,
  ::tensorflow::Input l1,
  ::tensorflow::Input l2,
  ::tensorflow::Input global_step,
  const SparseApplyAdagradDA::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
)
```