# tensorflow::ops::ResourceSparseApplyFtrl Class Reference

# tensorflow::ops::ResourceSparseApplyFtrl

`#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

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/resource-sparse-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_resource_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:

- the created `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation`

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-ftrl#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_1aee900421c9006251c84f6dd00fb1892d(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/resource-sparse-apply-ftrl#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_1aca1e9533dccd71ef1217f5b21b2429ae(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/resource-sparse-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-ftrl#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_1a8c62c5bad64bbb58ad975e6e6d6e7510` | `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-ftrl#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_1ad6adcd76de214e2887864742642d04a9() const ` | ` `` ` |

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

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

## Public attributes

### operation

```
Operation operation
```

## Public functions

### ResourceSparseApplyFtrl

```
 ResourceSparseApplyFtrl(
  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
)
```

### ResourceSparseApplyFtrl

```
 ResourceSparseApplyFtrl(
  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 ResourceSparseApplyFtrl::Attrs & attrs
)
```

### operator::tensorflow::Operation

```
 operator::tensorflow::Operation() const 
```

## Public static functions

### MultiplyLinearByLr

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

### UseLocking

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