# tensorflow::ops::ResourceSparseApplyRMSProp

`#include <training_ops.h>`

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

## Summary

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

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

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

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().
- 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.0/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-r-m-s-prop/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_r_m_s_prop_1_1_attrs`):

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

<br />

Returns:

- the created `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation`

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-r-m-s-prop#classtensorflow_1_1ops_1_1_resource_sparse_apply_r_m_s_prop_1aff53e99b8e6dc505fb48976158d11f39(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 ms, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input mom, ::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 rho, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input momentum, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input epsilon, ::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 indices)` ||
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-r-m-s-prop#classtensorflow_1_1ops_1_1_resource_sparse_apply_r_m_s_prop_1aba358e7d7c7d78bfcdc5eaed2530fa16(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 ms, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input mom, ::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 rho, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input momentum, ::https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input epsilon, ::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 indices, const https://www.tensorflow.org/versions/r2.0/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-r-m-s-prop/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_r_m_s_prop_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-r-m-s-prop#classtensorflow_1_1ops_1_1_resource_sparse_apply_r_m_s_prop_1abcff2e138b5825b7fe66d8d9e68c9b7f` | `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.0/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-r-m-s-prop#classtensorflow_1_1ops_1_1_resource_sparse_apply_r_m_s_prop_1ae4f96774d9e75c094f13f6ea8d5ca0b6() const ` | ` `` ` |

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

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

## Public attributes

### operation

```
Operation operation
```

## Public functions

### ResourceSparseApplyRMSProp

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

### ResourceSparseApplyRMSProp

```
 ResourceSparseApplyRMSProp(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::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 ResourceSparseApplyRMSProp::Attrs & attrs
)
```

### operator::tensorflow::Operation

```
 operator::tensorflow::Operation() const 
```

## Public static functions

### UseLocking

```
Attrs UseLocking(
  bool x
)
```