# tensorflow::ops::SparseApplyProximalAdagrad Class Reference

# tensorflow::ops::SparseApplyProximalAdagrad

`#include <training_ops.h>`

Sparse update entries in '\*var' and '\*accum' according to FOBOS algorithm.

## Summary

That is for rows we have grad for, we update var and accum as follows:

$$accum += grad \* grad$$ $$prox_v = var$$ $$prox_v -= lr \* grad \* (1 / sqrt(accum))$$ $$var = sign(prox_v)/(1+lr\*l2) \* max{\|prox_v\|-lr\*l1,0}$$

<br />

Arguments:

- scope: A [Scope](https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- var: Should be from a Variable().
- accum: Should be from a Variable().
- lr: Learning rate. Must be a scalar.
- l1: L1 regularization. Must be a scalar.
- l2: L2 regularization. Must be a scalar.
- grad: The gradient.
- indices: A vector of indices into the first dimension of var and accum.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-proximal-adagrad/attrs#structtensorflow_1_1ops_1_1_sparse_apply_proximal_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.3/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output`: Same as "var".

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-adagrad#classtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1a21fa09e8bdc18bd3af898fc1bac2db7c(const ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l1, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices)` ||
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-adagrad#classtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1a4fc83cfe61291fd343af1715a113991f(const ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l1, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, const https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-proximal-adagrad/attrs#structtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-adagrad#classtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1a5ed248aabc3f2e57bb2ec02474bae5eb` | `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-adagrad#classtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1ae76daa049da9c6791c3d1138600e1183` | `::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-adagrad#classtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1a0829699482ccdeaea83ed72824dca938() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-adagrad#classtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1a2eeecd8c1fe64b3647d9270491c25614() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-adagrad#classtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1a9c08fcd6cb0c47ffe0874f93e55c7b70() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-adagrad#classtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1a29609264681993d95d92afd7eb69e3b2(bool x)` | `https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-proximal-adagrad/attrs#structtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::SparseApplyProximalAdagrad::Attrs](https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-proximal-adagrad/attrs) | Optional attribute setters for [SparseApplyProximalAdagrad](https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-adagrad#classtensorflow_1_1ops_1_1_sparse_apply_proximal_adagrad). |

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### SparseApplyProximalAdagrad

```
 SparseApplyProximalAdagrad(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input accum,
  ::tensorflow::Input lr,
  ::tensorflow::Input l1,
  ::tensorflow::Input l2,
  ::tensorflow::Input grad,
  ::tensorflow::Input indices
)
```

### SparseApplyProximalAdagrad

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