# tensorflow::ops::ResourceApplyFtrl Class Reference

# tensorflow::
ops::
ResourceApplyFtrl

`
#include <training_ops.h>
`


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

## Summary


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


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.
- 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.5/api_docs/cc/struct/tensorflow/ops/resource-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_resource_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.5/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation
  `

<br />

| ### Constructors and Destructors ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-ftrl#classtensorflow_1_1ops_1_1_resource_apply_ftrl_1aad4d85a2e638469dbe3155f147f018c8 (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 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 lr_power) ` ||
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-ftrl#classtensorflow_1_1ops_1_1_resource_apply_ftrl_1ae2f90848aff4185a26250531866329e0 (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 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 lr_power, const https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_resource_apply_ftrl_1_1_attrs & attrs) ` ||

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

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

| ### Public static functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-ftrl#classtensorflow_1_1ops_1_1_resource_apply_ftrl_1a7a892213f526ce2f5d1355c8d51e7cae (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_resource_apply_ftrl_1_1_attrs ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-ftrl#classtensorflow_1_1ops_1_1_resource_apply_ftrl_1a9acb1a5775d104b181717db97bf46f54 (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-ftrl/attrs#structtensorflow_1_1ops_1_1_resource_apply_ftrl_1_1_attrs ` |

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

## Public attributes

### operation

```
Operation operation
```

## Public functions

### ResourceApplyFtrl

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

### ResourceApplyFtrl

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

### operator::tensorflow::Operation

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

## Public static functions

### MultiplyLinearByLr

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

### UseLocking

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