mindspore/docs/api/api_python/ops/mindspore.ops.ScatterNdAdd.rst

38 lines
2.0 KiB
ReStructuredText
Raw Normal View History

mindspore.ops.ScatterNdAdd
===========================
.. py:class:: mindspore.ops.ScatterNdAdd(use_locking=False)
使用给定值通过加法运算和输入索引更新Tensor值。在更新完成后输出 `input_x` ,这有利于更加方便地使用更新后的值。
`input_x` 的rank为P`indices` 的rank为Q `Q >= 2`
`indices` 的shape为 :math:`(i_0, i_1, ..., i_{Q-2}, N)` `N <= P`
`indices` 的最后一个维度(长度为 `N` )表示沿着 `input_x``N` 个维度进行切片。
`updates` 表示rank为 `Q-1+P-N` 的Tensorshape为 :math:`(i_0, i_1, ..., i_{Q-2}, x\_shape_N, ..., x\_shape_{P-1})`
输入的 `input_x``updates` 遵循隐式类型转换规则,以确保数据类型一致。
如果数据类型不同则低低精度数据类型将转换为高精度数据类型。当需要参数的数据类型转换时则会抛出RuntimeError异常。
**参数:**
- **use_locking** (bool) - 是否启用锁保护。默认值False。
**输入:**
- **input_x** (Parameter) - ScatterNdAdd的输入任意维度的Parameter。
- **indices** (Tensor) - 指定加法操作的索引数据类型为mindspore.int32。索引的rank必须至少为2并且 `indices_shape[-1] <= len(shape)`
- **updates** (Tensor) - 指定与 `input_x` 相加操作的Tensor数据类型与 `input_x` 相同shape为 `indices_shape[:-1] + x_shape[indices_shape[-1]:]`
**输出:**
Tensor更新后的 `input_x` shape和数据类型与 `input_x` 相同。
**异常:**
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices_shape[:-1] + x_shape[indices_shape[-1]:]`
- **RuntimeError** - 当 `input_x``updates` 类型不一致,需要进行类型转换时,如果 `updates` 不支持转成参数 `input_x` 需要的数据类型,就会报错。