# tensorflow::ops::SparseApplyProximalGradientDescent Class Reference

# tensorflow::
ops::
SparseApplyProximalGradientDescent

`
#include <training_ops.h>
`


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

## Summary


That is for rows we have grad for, we update var as follows:

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

<br />


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.
- grad: The gradient.
- indices: A vector of indices into the first dimension of var and accum.

<br />


Optional attributes (see
`
https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/sparse-apply-proximal-gradient-descent/attrs#structtensorflow_1_1ops_1_1_sparse_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/sparse-apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_sparse_apply_proximal_gradient_descent_1a372f39ab528e739f2009829f8209517b (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 grad, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices) ` ||
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_sparse_apply_proximal_gradient_descent_1a8ba255097ba97fd395eb2528cf675341 (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 grad, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, const https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/sparse-apply-proximal-gradient-descent/attrs#structtensorflow_1_1ops_1_1_sparse_apply_proximal_gradient_descent_1_1_attrs & attrs) ` ||

| ### Public attributes ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_sparse_apply_proximal_gradient_descent_1a8787a4b4f05f63e721e95dc8c8ae25e6 ` | ` 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/sparse-apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_sparse_apply_proximal_gradient_descent_1a0f7e7354d7d857df6ba06081c84b4f97 ` | ` :: 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/sparse-apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_sparse_apply_proximal_gradient_descent_1a479c0fc042fbe24ce695f756d8254d0b () const ` | ` ::tensorflow::Node * ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_sparse_apply_proximal_gradient_descent_1a94b9654761c297155f6b1ad3a8aa86e2 () const ` | ` ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/sparse-apply-proximal-gradient-descent#classtensorflow_1_1ops_1_1_sparse_apply_proximal_gradient_descent_1af963b74c94589fa8d01e7c6731da53f1 () const ` | ` ` |

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

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

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### SparseApplyProximalGradientDescent

```
 SparseApplyProximalGradientDescent(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input alpha,
  ::tensorflow::Input l1,
  ::tensorflow::Input l2,
  ::tensorflow::Input grad,
  ::tensorflow::Input indices
)
```

### SparseApplyProximalGradientDescent

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