Creates a new tensor by applying sparse `updates` to individual values or slices within a zero tensor of the given `shape` tensor according to indices.
This operator is the inverse of the [tf.gather_nd](#gather_nd) operator which extracts values or slices from a given tensor.
TODO(simister): Add a link to Variable.__getitem__ documentation on slice syntax.
`shape` is a `TensorShape` with rank `P` and `indices` is a `Tensor` of rank `Q`.
`indices` must be integer tensor, containing indices into `shape`.
It must be shape `[d_0, ..., d_{Q-2}, K]` where `0 < K <= P`.
The innermost dimension of `indices` (with length `K`) corresponds to
indices into elements (if `K = P`) or slices (if `K < P`) along the `K`th
dimension of `shape`.
`updates` is Tensor of rank `Q-1+P-K` with shape:
```
[d_0, ..., d_{Q-2}, shape[K], ..., shape[P-1]].
```
The simplest form of scatter is to insert individual elements in a tensor by index. For example, say we want to insert 4 scattered elements in a rank-1 tensor with 8 elements.
In Python, this scatter operation would look like this:
indices = tf.constant([[4], [3], [1], [7]])
updates = tf.constant([9, 10, 11, 12])
shape = tf.constant([8])
scatter = tf.scatter_nd(indices, updates, shape)
with tf.Session() as sess:
print sess.run(scatter)
The resulting tensor would look like this:
[0, 11, 0, 10, 9, 0, 0, 12]
We can also, insert entire slices of a higher rank tensor all at once. For example, if we wanted to insert two slices in the first dimension of a rank-3 tensor with two matrices of new values.
For example, say we want to subtract 4 scattered elements from a rank-1 tensor with 8 elements. In Python, that subtraction would look like this:
ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1], [7]])
updates = tf.constant([9, 10, 11, 12])
sub = tf.scatter_nd_sub(ref, indices, updates)
with tf.Session() as sess:
print sess.run(sub)
The resulting update to ref would look like this:
[1, -9, 3, -6, -4, 6, 7, -4]
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`.
A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to subtract from ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `False`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.
For example, say we want to add 4 scattered elements to a rank-1 tensor to 8 elements. In Python, that addition would look like this:
ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1], [7]])
updates = tf.constant([9, 10, 11, 12])
add = tf.scatter_nd_add(ref, indices, updates)
with tf.Session() as sess:
print sess.run(add)
The resulting update to ref would look like this:
[1, 13, 3, 14, 14, 6, 7, 20]
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`.
A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to add to ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `False`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`.
A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to subtract from ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `False`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.
Creates a new tensor by applying sparse `updates` to individual values or slices within a zero tensor of the given `shape` tensor according to indices.
This operator is the inverse of the [tf.gather_nd](#gather_nd) operator which extracts values or slices from a given tensor.
TODO(simister): Add a link to Variable.__getitem__ documentation on slice syntax.
`shape` is a `TensorShape` with rank `P` and `indices` is a `Tensor` of rank `Q`.
`indices` must be integer tensor, containing indices into `shape`.
It must be shape `[d_0, ..., d_{Q-2}, K]` where `0 < K <= P`.
The innermost dimension of `indices` (with length `K`) corresponds to
indices into elements (if `K = P`) or slices (if `K < P`) along the `K`th
dimension of `shape`.
`updates` is Tensor of rank `Q-1+P-K` with shape:
```
[d_0, ..., d_{Q-2}, shape[K], ..., shape[P-1]].
```
The simplest form of scatter is to insert individual elements in a tensor by index. For example, say we want to insert 4 scattered elements in a rank-1 tensor with 8 elements.
In Python, this scatter operation would look like this:
indices = tf.constant([[4], [3], [1], [7]])
updates = tf.constant([9, 10, 11, 12])
shape = tf.constant([8])
scatter = tf.scatter_nd(indices, updates, shape)
with tf.Session() as sess:
print sess.run(scatter)
The resulting tensor would look like this:
[0, 11, 0, 10, 9, 0, 0, 12]
We can also, insert entire slices of a higher rank tensor all at once. For example, if we wanted to insert two slices in the first dimension of a rank-3 tensor with two matrices of new values.
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to add to ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `True`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.
For example, say we want to multiply 4 scattered elements with a rank-1 tensor with 8 elements. In Python, that multiplication would look like this:
ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1], [7]])
updates = tf.constant([9, 10, 11, 12])
sub = tf.scatter_nd_mul(ref, indices, updates)
with tf.Session() as sess:
print sess.run(sub)
The resulting update to ref would look like this:
[1, 22, 3, 40, 45, 6, 7, 96]
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`.
A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to subtract from ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `False`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to add to ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `True`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.
For example, say we want to add 4 scattered elements to a rank-1 tensor to 8 elements. In Python, that addition would look like this:
ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1], [7]])
updates = tf.constant([9, 10, 11, 12])
add = tf.scatter_nd_add(ref, indices, updates)
with tf.Session() as sess:
print sess.run(add)
The resulting update to ref would look like this:
[1, 13, 3, 14, 14, 6, 7, 20]
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`.
A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to add to ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `False`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.
For example, say we want to subtract 4 scattered elements from a rank-1 tensor with 8 elements. In Python, that subtraction would look like this:
ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1], [7]])
updates = tf.constant([9, 10, 11, 12])
sub = tf.scatter_nd_sub(ref, indices, updates)
with tf.Session() as sess:
print sess.run(sub)
The resulting update to ref would look like this:
[1, -9, 3, -6, -4, 6, 7, -4]
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`.
A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to subtract from ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `False`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.
For example, say we want to multiply 4 scattered elements with a rank-1 tensor with 8 elements. In Python, that multiplication would look like this:
ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1], [7]])
updates = tf.constant([9, 10, 11, 12])
sub = tf.scatter_nd_mul(ref, indices, updates)
with tf.Session() as sess:
print sess.run(sub)
The resulting update to ref would look like this:
[1, 22, 3, 40, 45, 6, 7, 96]
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`.
A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to subtract from ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `False`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.
See [tf.scatter_nd](#scatter_nd) for more details about how to make updates to slices.
##### Args:
*<b>`ref`</b>: A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`.
A mutable Tensor. Should be from a Variable node.
*<b>`indices`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`.
A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref.
*<b>`updates`</b>: A `Tensor`. Must have the same type as `ref`.
A Tensor. Must have the same type as ref. A tensor of updated values to subtract from ref.
*<b>`use_locking`</b>: An optional `bool`. Defaults to `False`.
An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.
*<b>`name`</b>: A name for the operation (optional).
##### Returns:
A mutable `Tensor`. Has the same type as `ref`.
Same as ref. Returned as a convenience for operations that want to use the updated values after the update is done.