# tensorflow::ops::ApplyProximalGradientDescent Class Reference

# tensorflow::
ops::
ApplyProximalGradientDescent

`
#include <training_ops.h>
`


Update '\*var' as FOBOS algorithm with fixed learning rate.

## Summary


prox_v = var - alpha \* delta var = sign(prox_v)/(1+alpha\*l2) \* max{\|prox_v\|-alpha\*l1,0}


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

<br />


Optional attributes (see
`
https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/apply-proximal-gradient-descent/attrs#structtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1_1_attrs
`
):

- use_locking: If True, the subtraction 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/apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1a577feb7c1010835d2021ec6438a03e18 (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 alpha, :: 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 delta) ` ||
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1a72d2634c5478ad4b4713e1ad81a789f9 (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 alpha, :: 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 delta, const https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/apply-proximal-gradient-descent/attrs#structtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1_1_attrs & attrs) ` ||

| ### Public attributes ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1aa55ca8817e188f7a4e6191b47239f67e ` | ` 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/apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1a5c78a54b7a97b4031240bd2b4f21e747 ` | ` :: 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/apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1a8e7c76bc6bc033a17176899023e215fd () const ` | ` ::tensorflow::Node * ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1a1dfd24a06a5604ba3f0b372fc9936a3f () const ` | ` ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1a9e54dc150d7c007fbef0bff785608acf () const ` | ` ` |

| ### Public static functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1a09a254600f5323028ef7d0f93ec99bab (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/apply-proximal-gradient-descent/attrs#structtensorflow_1_1ops_1_1_apply_proximal_gradient_descent_1_1_attrs ` |

| ### Structs ||
|---|---|
| [tensorflow:: ops:: ApplyProximalGradientDescent:: Attrs](https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/apply-proximal-gradient-descent/attrs) | Optional attribute setters for [ApplyProximalGradientDescent](https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_apply_proximal_gradient_descent) . |

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### ApplyProximalGradientDescent

```
 ApplyProximalGradientDescent(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input alpha,
  ::tensorflow::Input l1,
  ::tensorflow::Input l2,
  ::tensorflow::Input delta
)
```

### ApplyProximalGradientDescent

```
 ApplyProximalGradientDescent(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input alpha,
  ::tensorflow::Input l1,
  ::tensorflow::Input l2,
  ::tensorflow::Input delta,
  const ApplyProximalGradientDescent::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
)
```