# tensorflow::ops::SparseApplyFtrl Class Reference

# tensorflow::ops::SparseApplyFtrl

`#include <training_ops.h>`

Update relevant entries in '\*var' according to the Ftrl-proximal scheme.

## Summary

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

$$accum_new = accum + grad \* grad$$ $$linear += grad + (accum_{new}\^{-lr_{power} } - accum\^{-lr_{power} } / lr \* var$$ $$quadratic = 1.0 / (accum_{new}\^{lr_{power} } \* lr) + 2 \* l2$$ $$var = (sign(linear) \* l1 - linear) / quadratic\\ if\\ \|linear\| \> l1\\ else\\ 0.0$$ $$accum = accum_{new}$$

<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().
- linear: Should be from a Variable().
- grad: The gradient.
- indices: A vector of indices into the first dimension of var and accum.
- lr: Scaling factor. Must be a scalar.
- l1: L1 regularization. Must be a scalar.
- l2: L2 regularization. Must be a scalar.
- lr_power: Scaling factor. Must be a scalar.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_sparse_apply_ftrl_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-ftrl#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_1acfbd35749a971ae408ba24c0bb56facd(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 linear, ::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/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 lr_power)` ||
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_1ae80720b9dac0b6801255f556bd27e249(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 linear, ::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/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 lr_power, const https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_sparse_apply_ftrl_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_1ac97a954bbe52219dcd24e48de02f37e2` | `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-ftrl#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_1aade91702a26588081047940b922727e9` | `::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-ftrl#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_1acd3ec55f3b5d70e30f21395166e3c638() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_1afa8bb71a8583497722ad2240f94c157f() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_1a5964fb493100ead822e39ca5e2ed2710() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_1acef8fb56b82d9db9afc13e42ff82e9aa(bool x)` | `https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_sparse_apply_ftrl_1_1_attrs` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_1aa19ce04694959f2590e9a0286d0ff8b9(bool x)` | `https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_sparse_apply_ftrl_1_1_attrs` |

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

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### SparseApplyFtrl

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

### SparseApplyFtrl

```
 SparseApplyFtrl(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input accum,
  ::tensorflow::Input linear,
  ::tensorflow::Input grad,
  ::tensorflow::Input indices,
  ::tensorflow::Input lr,
  ::tensorflow::Input l1,
  ::tensorflow::Input l2,
  ::tensorflow::Input lr_power,
  const SparseApplyFtrl::Attrs & attrs
)
```

### node

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

### operator::tensorflow::Input

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

### operator::tensorflow::Output

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

## Public static functions

### MultiplyLinearByLr

```
Attrs MultiplyLinearByLr(
  bool x
)
```

### UseLocking

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