# tensorflow::ops::SparseApplyCenteredRMSProp Class Reference

# tensorflow::ops::SparseApplyCenteredRMSProp

`#include <training_ops.h>`

Update '\*var' according to the centered RMSProp algorithm.

## Summary

The centered RMSProp algorithm uses an estimate of the centered second moment (i.e., the variance) for normalization, as opposed to regular RMSProp, which uses the (uncentered) second moment. This often helps with training, but is slightly more expensive in terms of computation and memory.

Note that in dense implementation of this algorithm, mg, ms, and mom will update even if the grad is zero, but in this sparse implementation, mg, ms, and mom will not update in iterations during which the grad is zero.

mean_square = decay \* mean_square + (1-decay) \* gradient \*\* 2 mean_grad = decay \* mean_grad + (1-decay) \* gradient Delta = learning_rate \* gradient / sqrt(mean_square + epsilon - mean_grad \*\* 2)


$$ms \<- rho \* ms_{t-1} + (1-rho) \* grad \* grad$$ $$mom \<- momentum \* mom_{t-1} + lr \* grad / sqrt(ms + epsilon)$$ $$var \<- var - mom$$

<br />

Arguments:

- scope: A [Scope](https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- var: Should be from a Variable().
- mg: Should be from a Variable().
- ms: Should be from a Variable().
- mom: Should be from a Variable().
- lr: Scaling factor. Must be a scalar.
- rho: Decay rate. Must be a scalar.
- epsilon: Ridge term. Must be a scalar.
- grad: The gradient.
- indices: A vector of indices into the first dimension of var, ms and mom.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-centered-r-m-s-prop/attrs#structtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1_1_attrs`):

- use_locking: If `True`, updating of the var, mg, ms, and mom tensors is protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.

<br />

Returns:

- `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output`: Same as "var".

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-centered-r-m-s-prop#classtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1a306add3ddfecbb8c1c17a577e7545e18(const ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input mg, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input ms, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input mom, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input rho, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input momentum, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input epsilon, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices)` ||
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-centered-r-m-s-prop#classtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1a16ead662d87edcd1c60c7978723dbe5c(const ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input var, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input mg, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input ms, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input mom, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input rho, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input momentum, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input epsilon, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, const https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-centered-r-m-s-prop/attrs#structtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-centered-r-m-s-prop#classtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1a65849928c734bc61b5c2b280b499c580` | `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-centered-r-m-s-prop#classtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1a212e3ee046b968fe1e39437eb322295f` | `::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-centered-r-m-s-prop#classtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1afda472071705ded9acb97bdef672fe98() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-centered-r-m-s-prop#classtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1a33540e30f16d6e579d7f6dddc271d3e8() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-centered-r-m-s-prop#classtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1afe37be981a644873b8b076eab5801804() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-centered-r-m-s-prop#classtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1a36f5242f1272ec92a4e3ad5a82574090(bool x)` | `https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-centered-r-m-s-prop/attrs#structtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::SparseApplyCenteredRMSProp::Attrs](https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/sparse-apply-centered-r-m-s-prop/attrs) | Optional attribute setters for [SparseApplyCenteredRMSProp](https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/sparse-apply-centered-r-m-s-prop#classtensorflow_1_1ops_1_1_sparse_apply_centered_r_m_s_prop). |

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### SparseApplyCenteredRMSProp

```
 SparseApplyCenteredRMSProp(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input mg,
  ::tensorflow::Input ms,
  ::tensorflow::Input mom,
  ::tensorflow::Input lr,
  ::tensorflow::Input rho,
  ::tensorflow::Input momentum,
  ::tensorflow::Input epsilon,
  ::tensorflow::Input grad,
  ::tensorflow::Input indices
)
```

### SparseApplyCenteredRMSProp

```
 SparseApplyCenteredRMSProp(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input mg,
  ::tensorflow::Input ms,
  ::tensorflow::Input mom,
  ::tensorflow::Input lr,
  ::tensorflow::Input rho,
  ::tensorflow::Input momentum,
  ::tensorflow::Input epsilon,
  ::tensorflow::Input grad,
  ::tensorflow::Input indices,
  const SparseApplyCenteredRMSProp::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
)
```