# tensorflow::ops::ApplyAddSign Class Reference

# tensorflow::
ops::
ApplyAddSign

`
#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/apply-add-sign/attrs#structtensorflow_1_1ops_1_1_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:

- `
  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-add-sign#classtensorflow_1_1ops_1_1_apply_add_sign_1af9f940a5ce219f006dd5784273581462 (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/apply-add-sign#classtensorflow_1_1ops_1_1_apply_add_sign_1a8ced306386cbe8552a1acb0c7c9f7640 (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/apply-add-sign/attrs#structtensorflow_1_1ops_1_1_apply_add_sign_1_1_attrs & attrs) ` ||

| ### Public attributes ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-add-sign#classtensorflow_1_1ops_1_1_apply_add_sign_1a2f3006bfafb719f77fb48b78d7ea9db3 ` | ` 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-add-sign#classtensorflow_1_1ops_1_1_apply_add_sign_1a7880929b8fb7c7581f00030a85654100 ` | ` :: 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-add-sign#classtensorflow_1_1ops_1_1_apply_add_sign_1a71f7d03f4328c2e8d1901785967d44b3 () const ` | ` ::tensorflow::Node * ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-add-sign#classtensorflow_1_1ops_1_1_apply_add_sign_1a92da05431d90f30e0785c8a850de7b3e () const ` | ` ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/apply-add-sign#classtensorflow_1_1ops_1_1_apply_add_sign_1ac1522c1a1317ddde43e2198c6d6c0337 () const ` | ` ` |

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

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

## Public attributes

### operation

```
Operation operation
```

### out

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

## Public functions

### ApplyAddSign

```
 ApplyAddSign(
  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
)
```

### ApplyAddSign

```
 ApplyAddSign(
  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 ApplyAddSign::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
)
```