# tensorflow::ops::SparseApplyFtrlV2 Class Reference

# tensorflow::
ops::
SparseApplyFtrlV2

`
#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: grad_with_shrinkage = grad + 2 \* l2_shrinkage \* var accum_new = accum + grad \* grad linear += grad_with_shrinkage - (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


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().
- 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 shrinkage regularization. Must be a scalar.
- lr_power: Scaling factor. Must be a scalar.

<br />


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

<br />

| ### Constructors and Destructors ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1a5aac85294ef2fe3491d385699c320466 (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 accum, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input linear, :: 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/input#classtensorflow_1_1_input indices, :: 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 l1, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2_shrinkage, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr_power) ` ||
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1abf2e6f5633ae8e3bf9dfbeb7222d1f5e (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 accum, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input linear, :: 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/input#classtensorflow_1_1_input indices, :: 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 l1, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2_shrinkage, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr_power, const https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/sparse-apply-ftrl-v2/attrs#structtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1_1_attrs & attrs) ` ||

| ### Public attributes ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1a52c8adace57b2f5a40dba99db1ad4e88 ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1ae87d85671d97e97a7662c7c680fc8884 ` | ` :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output ` |

| ### Public functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1ae9527252eb9b5e39d1cc50fe962c03dd () const ` | ` ::tensorflow::Node * ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1a1acf8e4ced3659d1ceecb99da65de05d () const ` | ` ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1ac88538dc7963ebfe36cb619839f53581 () const ` | ` ` |

| ### Public static functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1ade792da0a6f7add88bff4d13d98f32c3 (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/sparse-apply-ftrl-v2/attrs#structtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1_1_attrs ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1a0ca751635f400261887fe95775ea4c48 (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/sparse-apply-ftrl-v2/attrs#structtensorflow_1_1ops_1_1_sparse_apply_ftrl_v2_1_1_attrs ` |

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

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### SparseApplyFtrlV2

```
 SparseApplyFtrlV2(
  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 l2_shrinkage,
  ::tensorflow::Input lr_power
)
```

### SparseApplyFtrlV2

```
 SparseApplyFtrlV2(
  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 l2_shrinkage,
  ::tensorflow::Input lr_power,
  const SparseApplyFtrlV2::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
)
```