# tensorflow::ops::ApplyFtrl

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

Arguments:

- scope: A [Scope](https://www.tensorflow.org/versions/r2.0/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 regulariation. Must be a scalar.
- l2: L2 regulariation. Must be a scalar.
- lr_power: Scaling factor. Must be a scalar.

<br />

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

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-ftrl#classtensorflow_1_1ops_1_1_apply_ftrl_1aac92c9a511a285b2ba2fd70bb8a9162a(const ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input linear, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l1, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr_power)` ||
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-ftrl#classtensorflow_1_1ops_1_1_apply_ftrl_1a08ae5f59e96c0806cac695b49d0b7e6c(const ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input accum, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input linear, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l1, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input l2, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr_power, const https://www.tensorflow.org/versions/r2.0/api_docs/cc/struct/tensorflow/ops/apply-ftrl/attrs#structtensorflow_1_1ops_1_1_apply_ftrl_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-ftrl#classtensorflow_1_1ops_1_1_apply_ftrl_1a60bfef0fb8957ad8ebd90bcc1b17deb5` | `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-ftrl#classtensorflow_1_1ops_1_1_apply_ftrl_1a4ce2fdad41c33119e072faa142ab6388` | `::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-ftrl#classtensorflow_1_1ops_1_1_apply_ftrl_1a83ed3b447bb12a6a2026a5ecd546311c() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-ftrl#classtensorflow_1_1ops_1_1_apply_ftrl_1a93e6e2aec1e38ede37126e36574daf64() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-ftrl#classtensorflow_1_1ops_1_1_apply_ftrl_1aae1ab05c604dfd771e781b62fa213b30() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-ftrl#classtensorflow_1_1ops_1_1_apply_ftrl_1a1052290b6434db12d630a2e9d0b1b197(bool x)` | `https://www.tensorflow.org/versions/r2.0/api_docs/cc/struct/tensorflow/ops/apply-ftrl/attrs#structtensorflow_1_1ops_1_1_apply_ftrl_1_1_attrs` |

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

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### ApplyFtrl

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

### ApplyFtrl

```
 ApplyFtrl(
  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 ApplyFtrl::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
)
```