mindspore2022/docs/api/api_python/ops/mindspore.ops.ScatterNd.rst

mindspore.ops.ScatterNd
========================

.. py:class:: mindspore.ops.ScatterNd

    根据指定的索引将更新值散布到新Tensor上。

    使用给定的 `shape` 创建一个空Tensor，并将 `updates` 的值通过索引来设置空Tensor的值。

    空Tensor的秩为P，而 `indices` 的秩为Q， `Q >= 2` 。

    `indices` 的shape为 :math:`(i_0, i_1, ..., i_{Q-2}, N)` ， `N <= P` 。

    `indices` 的最后一个维度（长度为 `N` ）表示沿着空Tensor的 `N` 个维度进行切片。

    `updates` 表示秩为 `Q-1+P-N` 的Tensor，shape为 :math:`(i_0, i_1, ..., i_{Q-2}, shape_N, ..., shape_{P-1})` 。

    在秩为3的第一个维度中插入两个新值矩阵的计算过程如下图所示：

    .. image:: ScatterNd.png

    **输入：**

    - **indices** (Tensor) - 指定新Tensor中散布的索引，数据类型为int32或int64。索引的秩须至少为2，并且 `indices_shape[-1] <= len(shape)` 。
    - **updates** (Tensor) - 指定更新Tensor，shape为 `indices_shape[:-1] + shape[indices_shape[-1]:]` 。
    - **shape** (tuple[int]) - 指定输出Tensor的shape，数据类型与索引相同。 `shape` 为 :math:`(x_1, x_2, ..., x_R)` 且 `shape` 的长度大于或等于2。换句话说， `shape` 至少是 :math:`(x_1, x_2)` ，且 `shape` 中的任何元素的值都必须大于等于1。也就是说， :math:`x_1` >= 1， :math:`x_2` >= 1。

    **输出：**

    Tensor，更新后的Tensor，数据类型与输入 `update` 相同，shape与输入 `shape` 相同。

    **异常：**

    - **TypeError** - `shape` 不是tuple。
    - **ValueError** - `shape` 的任何元素小于1。