diff options
Diffstat (limited to 'tensorflow/core/api_def/base_api/api_def_ScatterMin.pbtxt')
-rw-r--r-- | tensorflow/core/api_def/base_api/api_def_ScatterMin.pbtxt | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/tensorflow/core/api_def/base_api/api_def_ScatterMin.pbtxt b/tensorflow/core/api_def/base_api/api_def_ScatterMin.pbtxt new file mode 100644 index 0000000000..721ac0ff35 --- /dev/null +++ b/tensorflow/core/api_def/base_api/api_def_ScatterMin.pbtxt @@ -0,0 +1,60 @@ +op { + graph_op_name: "ScatterMin" + in_arg { + name: "ref" + description: <<END +Should be from a `Variable` node. +END + } + in_arg { + name: "indices" + description: <<END +A tensor of indices into the first dimension of `ref`. +END + } + in_arg { + name: "updates" + description: <<END +A tensor of updated values to reduce into `ref`. +END + } + out_arg { + name: "output_ref" + description: <<END += Same as `ref`. Returned as a convenience for operations that want +to use the updated values after the update is done. +END + } + attr { + name: "use_locking" + description: <<END +If True, the update will be protected by a lock; +otherwise the behavior is undefined, but may exhibit less contention. +END + } + summary: "Reduces sparse updates into a variable reference using the `min` operation." + description: <<END +This operation computes + + # Scalar indices + ref[indices, ...] = min(ref[indices, ...], updates[...]) + + # Vector indices (for each i) + ref[indices[i], ...] = min(ref[indices[i], ...], updates[i, ...]) + + # High rank indices (for each i, ..., j) + ref[indices[i, ..., j], ...] = min(ref[indices[i, ..., j], ...], updates[i, ..., j, ...]) + +This operation outputs `ref` after the update is done. +This makes it easier to chain operations that need to use the reset value. + +Duplicate entries are handled correctly: if multiple `indices` reference +the same location, their contributions combine. + +Requires `updates.shape = indices.shape + ref.shape[1:]` or `updates.shape = []`. + +<div style="width:70%; margin:auto; margin-bottom:10px; margin-top:20px;"> +<img style="width:100%" src="https://www.tensorflow.org/images/ScatterAdd.png" alt> +</div> +END +} |