Warning: This API is deprecated and will be removed in a future
version of TensorFlow after
the replacement is stable.
ScatterNdUpdate
Stay organized with collections
Save and categorize content based on your preferences.
Applies sparse `updates` to individual values or slices within a given
variable according to `indices`.
`ref` is a `Tensor` with rank `P` and `indices` is a `Tensor` of rank `Q`.
`indices` must be integer tensor, containing indices into `ref`.
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 `ref`.
`updates` is `Tensor` of rank `Q-1+P-K` with shape:
$$[d_0, ..., d_{Q-2}, ref.shape[K], ..., ref.shape[P-1]].$$
For example, say we want to update 4 scattered elements to a rank-1 tensor to
8 elements. In Python, that update 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])
update = tf.scatter_nd_update(ref, indices, updates)
with tf.Session() as sess:
print sess.run(update)
The resulting update to ref would look like this:
[1, 11, 3, 10, 9, 6, 7, 12]
See tf.scatter_nd
for more details about how to make updates to
slices.
See also `tf.scatter_update` and `tf.batch_scatter_update`.
Inherited Methods
From class
java.lang.Object
boolean
|
equals(Object arg0)
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
Public Methods
public
Output<T>
asOutput
()
Returns the symbolic handle of a tensor.
Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is
used to obtain a symbolic handle that represents the computation of the input.
Factory method to create a class wrapping a new ScatterNdUpdate operation.
Parameters
scope |
current scope |
ref |
A mutable Tensor. Should be from a Variable node. |
indices |
A Tensor. Must be one of the following types: int32, int64.
A tensor of indices into ref. |
updates |
A Tensor. Must have the same type as ref. A tensor of updated
values to add to ref. |
options |
carries optional attributes values |
Returns
- a new instance of ScatterNdUpdate
public
Output<T>
outputRef
()
Same as ref. Returned as a convenience for operations that want to
use the updated values after the update is done.
Parameters
useLocking |
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.
|
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 2022-02-12 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-02-12 UTC."],[],[],null,["# ScatterNdUpdate\n\npublic final class **ScatterNdUpdate** \nApplies sparse \\`updates\\` to individual values or slices within a given\n\n\nvariable according to \\`indices\\`.\n\n\n\\`ref\\` is a \\`Tensor\\` with rank \\`P\\` and \\`indices\\` is a \\`Tensor\\` of rank \\`Q\\`.\n\n\n\\`indices\\` must be integer tensor, containing indices into \\`ref\\`.\nIt must be shape \\\\\\\\(\\[d_0, ..., d_{Q-2}, K\\]\\\\\\\\) where \\`0 \\\u003c K \\\u003c= P\\`.\n\n\nThe innermost dimension of \\`indices\\` (with length \\`K\\`) corresponds to\nindices into elements (if \\`K = P\\`) or slices (if \\`K \\\u003c P\\`) along the \\`K\\`th\ndimension of \\`ref\\`.\n\n\n\\`updates\\` is \\`Tensor\\` of rank \\`Q-1+P-K\\` with shape:\n\n\n$$\\[d_0, ..., d_{Q-2}, ref.shape\\[K\\], ..., ref.shape\\[P-1\\]\\].$$\n\n\nFor example, say we want to update 4 scattered elements to a rank-1 tensor to\n8 elements. In Python, that update would look like this: \n\n ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])\n indices = tf.constant([[4], [3], [1] ,[7]])\n updates = tf.constant([9, 10, 11, 12])\n update = tf.scatter_nd_update(ref, indices, updates)\n with tf.Session() as sess:\n print sess.run(update)\n \nThe resulting update to ref would look like this:\n\n\n\\[1, 11, 3, 10, 9, 6, 7, 12\\]\n\n\nSee [`tf.scatter_nd`](https://www.tensorflow.org/api_docs/python/tf/scatter_nd) for more details about how to make updates to\nslices.\n\n\nSee also \\`tf.scatter_update\\` and \\`tf.batch_scatter_update\\`.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n### Nested Classes\n\n|-------|---|---|--------------------------------------------------------------------------------------------------|\n| class | [ScatterNdUpdate.Options](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate.Options) || Optional attributes for [ScatterNdUpdate](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate) |\n\n### Public Methods\n\n|--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e | [asOutput](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate#asOutput())() Returns the symbolic handle of a tensor. |\n| static \\\u003cT, U extends Number\\\u003e [ScatterNdUpdate](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate)\\\u003cT\\\u003e | [create](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand\u003cT\u003e,%20org.tensorflow.Operand\u003cU\u003e,%20org.tensorflow.Operand\u003cT\u003e,%20org.tensorflow.op.core.ScatterNdUpdate.Options...))([Scope](/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cT\\\u003e ref, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cU\\\u003e indices, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cT\\\u003e updates, [Options...](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate.Options) options) Factory method to create a class wrapping a new ScatterNdUpdate operation. |\n| [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e | [outputRef](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate#outputRef())() Same as ref. |\n| static [ScatterNdUpdate.Options](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate.Options) | [useLocking](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate#useLocking(java.lang.Boolean))(Boolean useLocking) |\n\n### Inherited Methods\n\nFrom class [org.tensorflow.op.PrimitiveOp](/api_docs/java/org/tensorflow/op/PrimitiveOp) \n\n|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| final boolean | [equals](/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |\n| final int | [hashCode](/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |\n| [Operation](/api_docs/java/org/tensorflow/Operation) | [op](/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying [Operation](/api_docs/java/org/tensorflow/Operation) |\n| final String | [toString](/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |\n\nFrom class java.lang.Object \n\n|------------------|---------------------------|\n| boolean | equals(Object arg0) |\n| final Class\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| String | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nFrom interface [org.tensorflow.Operand](/api_docs/java/org/tensorflow/Operand) \n\n|--------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|\n| abstract [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e | [asOutput](/api_docs/java/org/tensorflow/Operand#asOutput())() Returns the symbolic handle of a tensor. |\n\nPublic Methods\n--------------\n\n#### public [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e\n**asOutput**\n()\n\nReturns the symbolic handle of a tensor.\n\nInputs to TensorFlow operations are outputs of another TensorFlow operation. This method is\nused to obtain a symbolic handle that represents the computation of the input.\n\n\u003cbr /\u003e\n\n#### public static [ScatterNdUpdate](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate)\\\u003cT\\\u003e\n**create**\n([Scope](/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cT\\\u003e ref, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cU\\\u003e indices, [Operand](/api_docs/java/org/tensorflow/Operand)\\\u003cT\\\u003e updates, [Options...](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate.Options) options)\n\nFactory method to create a class wrapping a new ScatterNdUpdate operation. \n\n##### Parameters\n\n| scope | current scope |\n| ref | A mutable Tensor. Should be from a Variable node. |\n| indices | A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref. |\n| updates | A Tensor. Must have the same type as ref. A tensor of updated values to add to ref. |\n| options | carries optional attributes values |\n|---------|-------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- a new instance of ScatterNdUpdate \n\n#### public [Output](/api_docs/java/org/tensorflow/Output)\\\u003cT\\\u003e\n**outputRef**\n()\n\nSame as ref. Returned as a convenience for operations that want to\nuse the updated values after the update is done. \n\n#### public static [ScatterNdUpdate.Options](/api_docs/java/org/tensorflow/op/core/ScatterNdUpdate.Options)\n**useLocking**\n(Boolean useLocking)\n\n\u003cbr /\u003e\n\n##### Parameters\n\n| useLocking | 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. |\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|"]]