tf.assign_sub
Stay organized with collections
Save and categorize content based on your preferences.
Update ref
by subtracting value
from it.
tf.assign_sub(
ref, value, use_locking=None, name=None
)
This operation outputs ref
after the update is done.
This makes it easier to chain operations that need to use the reset value.
Unlike tf.math.subtract
, this op does not broadcast. ref
and value
must have the same shape.
Args |
ref
|
A mutable Tensor . Must be one of the following types: float32 ,
float64 , int64 , int32 , uint8 , uint16 , int16 , int8 ,
complex64 , complex128 , qint8 , quint8 , qint32 , half . Should be
from a Variable node.
|
value
|
A Tensor . Must have the same shape and dtype as ref . The value to
be subtracted to the variable.
|
use_locking
|
An optional bool . Defaults to False . If True, the
subtraction will be protected by a lock; otherwise the behavior is
undefined, but may exhibit less contention.
|
name
|
A name for the operation (optional).
|
Returns |
Same as "ref". Returned as a convenience for operations that want
to use the new value after the variable has been updated.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-10-01 UTC.
[null,null,["Last updated 2020-10-01 UTC."],[],[],null,["# tf.assign_sub\n\n\u003cbr /\u003e\n\n|-----------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/ops/state_ops.py#L136-L164) |\n\nUpdate `ref` by subtracting `value` from it.\n\n#### View aliases\n\n\n**Compat aliases for migration**\n\nSee\n[Migration guide](https://www.tensorflow.org/guide/migrate) for\nmore details.\n\n[`tf.compat.v1.assign_sub`](/api_docs/python/tf/compat/v1/assign_sub)\n\n\u003cbr /\u003e\n\n tf.assign_sub(\n ref, value, use_locking=None, name=None\n )\n\nThis operation outputs `ref` after the update is done.\nThis makes it easier to chain operations that need to use the reset value.\nUnlike [`tf.math.subtract`](../tf/math/subtract), this op does not broadcast. `ref` and `value`\nmust have the same shape.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ref` | A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`. Should be from a `Variable` node. |\n| `value` | A `Tensor`. Must have the same shape and dtype as `ref`. The value to be subtracted to the variable. |\n| `use_locking` | An optional `bool`. Defaults to `False`. If True, the subtraction will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention. |\n| `name` | A name for the operation (optional). |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| Same as \"ref\". Returned as a convenience for operations that want to use the new value after the variable has been updated. ||\n\n\u003cbr /\u003e"]]