# tensorflow::ops::ApplyProximalAdagrad

`#include <training_ops.h>`

Update '\*var' and '\*accum' according to FOBOS with Adagrad learning rate.

## Summary

accum += grad \* grad prox_v = var - lr \* grad \* (1 / sqrt(accum)) var = sign(prox_v)/(1+lr\*l2) \* max{\|prox_v\|-lr\*l1,0}

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().
- lr: Scaling factor. Must be a scalar.
- l1: L1 regularization. Must be a scalar.
- l2: L2 regularization. Must be a scalar.
- grad: The gradient.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.0/api_docs/cc/struct/tensorflow/ops/apply-proximal-adagrad/attrs#structtensorflow_1_1ops_1_1_apply_proximal_adagrad_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-proximal-adagrad#classtensorflow_1_1ops_1_1_apply_proximal_adagrad_1ad631e66a4af770b5e290d54095645039(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 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 grad)` ||
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-proximal-adagrad#classtensorflow_1_1ops_1_1_apply_proximal_adagrad_1a6197e139173a7abb3bda5dc8cd631cc4(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 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 grad, const https://www.tensorflow.org/versions/r2.0/api_docs/cc/struct/tensorflow/ops/apply-proximal-adagrad/attrs#structtensorflow_1_1ops_1_1_apply_proximal_adagrad_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-proximal-adagrad#classtensorflow_1_1ops_1_1_apply_proximal_adagrad_1aab516e6991e64c35481834487b8d2203` | `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-proximal-adagrad#classtensorflow_1_1ops_1_1_apply_proximal_adagrad_1a53cf9fc743a8b5c317066ce86c2cff4e` | `::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-proximal-adagrad#classtensorflow_1_1ops_1_1_apply_proximal_adagrad_1a6485f5175e0c9a32f3ea0a5ca9997bfa() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-proximal-adagrad#classtensorflow_1_1ops_1_1_apply_proximal_adagrad_1aaa631be6296658ab1f47f52b03291167() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/apply-proximal-adagrad#classtensorflow_1_1ops_1_1_apply_proximal_adagrad_1a1727266f9db90b1162fda6fe029cd841() const ` | ` `` ` |

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

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

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### ApplyProximalAdagrad

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

### ApplyProximalAdagrad

```
 ApplyProximalAdagrad(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input accum,
  ::tensorflow::Input lr,
  ::tensorflow::Input l1,
  ::tensorflow::Input l2,
  ::tensorflow::Input grad,
  const ApplyProximalAdagrad::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
)
```