# tensorflow::ops::ResourceApplyAddSign Class Reference

# tensorflow::
ops::
ResourceApplyAddSign

`
#include <training_ops.h>
`


Update '\*var' according to the AddSign update.

## Summary


m_t \<- beta1 \* m_{t-1} + (1 - beta1) \* g update \<- (alpha + sign_decay \* sign(g) \*sign(m)) \* g variable \<- variable - lr_t \* update


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().
- m: Should be from a Variable().
- lr: Scaling factor. Must be a scalar.
- alpha: Must be a scalar.
- sign_decay: Must be a scalar.
- beta: Must be a scalar.
- grad: The gradient.

<br />


Optional attributes (see
`
https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-add-sign/attrs#structtensorflow_1_1ops_1_1_resource_apply_add_sign_1_1_attrs
`
):

- use_locking: If `
  True
  ` , updating of the var and m 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.5/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation
  `

<br />

| ### Constructors and Destructors ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-add-sign#classtensorflow_1_1ops_1_1_resource_apply_add_sign_1a0537575d071b484d5dff692e05084ca7 (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 m, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, :: 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 sign_decay, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta, :: 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/ops/resource-apply-add-sign#classtensorflow_1_1ops_1_1_resource_apply_add_sign_1aadd92ababa5fdbbad37d4375f29eb8dc (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 m, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input lr, :: 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 sign_decay, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input beta, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input grad, const https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-add-sign/attrs#structtensorflow_1_1ops_1_1_resource_apply_add_sign_1_1_attrs & attrs) ` ||

| ### Public attributes ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-add-sign#classtensorflow_1_1ops_1_1_resource_apply_add_sign_1a1cd2f7a0cc45a947807eafb75c32d002 ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation ` |

| ### Public functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-add-sign#classtensorflow_1_1ops_1_1_resource_apply_add_sign_1a7f0642c4cf6e69cc96b4102b61504f26 () const ` | ` ` |

| ### Public static functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-add-sign#classtensorflow_1_1ops_1_1_resource_apply_add_sign_1a9303912bb40b03efeb6f25dc94cb1de5 (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-add-sign/attrs#structtensorflow_1_1ops_1_1_resource_apply_add_sign_1_1_attrs ` |

| ### Structs ||
|---|---|
| [tensorflow:: ops:: ResourceApplyAddSign:: Attrs](https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/resource-apply-add-sign/attrs) | Optional attribute setters for [ResourceApplyAddSign](https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/resource-apply-add-sign#classtensorflow_1_1ops_1_1_resource_apply_add_sign) . |

## Public attributes

### operation

```
Operation operation
```

## Public functions

### ResourceApplyAddSign

```
 ResourceApplyAddSign(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input m,
  ::tensorflow::Input lr,
  ::tensorflow::Input alpha,
  ::tensorflow::Input sign_decay,
  ::tensorflow::Input beta,
  ::tensorflow::Input grad
)
```

### ResourceApplyAddSign

```
 ResourceApplyAddSign(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input var,
  ::tensorflow::Input m,
  ::tensorflow::Input lr,
  ::tensorflow::Input alpha,
  ::tensorflow::Input sign_decay,
  ::tensorflow::Input beta,
  ::tensorflow::Input grad,
  const ResourceApplyAddSign::Attrs & attrs
)
```

### operator::tensorflow::Operation

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

## Public static functions

### UseLocking

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