mindspore.Tensor.scatter

mindspore.Tensor.scatter(dim, index, src)

根据指定索引将 src 中的值更新到 self 中返回输出。对于一个3D的Tensor, 输出形式如下所示：

output[index[i][j][k]][j][k] = src[i][j][k]  # if dim == 0

output[i][index[i][j][k]][k] = src[i][j][k]  # if dim == 1

output[i][j][index[i][j][k]] = src[i][j][k]  # if dim == 2

说明

如果src为Tensor，则仅当src的shape和index的shape相同时支持求反向梯度。输入Tensor self 的秩必须至少为1。

参数：

dim (int) - 要进行更新操作的轴。取值范围是[-r, r)，其中r是 self 的秩。
index (Tensor) - 输入Tensor的索引，数据类型为int32或int64的正整数。其rank必须和 self 一致。取值范围是[-s, s)，这里的s是 self 在 axis 指定轴的size。
src (Tensor, float) - 指定对 self 进行更新操作的数据。可以为Tensor，此时其数据类型必须与输入 self 的数据类型相同。也可以是个float类型的标量。

返回：

Tensor，shape和数据类型与输入 self 相同。

异常：

TypeError - index 的数据类型既不是int32，也不是int64。
ValueError - self 、 index 和 src 中，任意一者的秩小于1。
ValueError - src 的秩和 self 的秩不一样。
TypeError - self 的数据类型和 src 的数据类型不一致。
RuntimeError - index 中存在负数。

支持平台：

Ascend GPU CPU

样例：

>>> import numpy as np
>>> import mindspore as ms
>>> from mindspore import Tensor, mint
>>> input = Tensor(np.array([[1, 2, 3, 4, 5]]), dtype=ms.float32)
>>> src = Tensor(np.array([[8, 8]]), dtype=ms.float32)
>>> index = Tensor(np.array([[2, 4]]), dtype=ms.int64)
>>> out = mint.scatter(input=input, dim=1, index=index, src=src)
>>> print(out)
[[1. 2. 8. 4. 8.]]
>>> input = Tensor(np.zeros((5, 5)), dtype=ms.float32)
>>> src = Tensor(np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]]), dtype=ms.float32)
>>> index = Tensor(np.array([[0, 0, 0], [2, 2, 2], [4, 4, 4]]), dtype=ms.int64)
>>> out = mint.scatter(input=input, dim=0, index=index, src=src)
>>> print(out)
[[1. 2. 3. 0. 0.]
 [0. 0. 0. 0. 0.]
 [4. 5. 6. 0. 0.]
 [0. 0. 0. 0. 0.]
 [7. 8. 9. 0. 0.]]
>>> input = Tensor(np.zeros((5, 5)), dtype=ms.float32)
>>> src = Tensor(np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]]), dtype=ms.float32)
>>> index = Tensor(np.array([[0, 2, 4], [0, 2, 4], [0, 2, 4]]), dtype=ms.int64)
>>> out = mint.scatter(input=input, dim=1, index=index, src=src)
>>> print(out)
[[1. 0. 2. 0. 3.]
 [4. 0. 5. 0. 6.]
 [7. 0. 8. 0. 9.]
 [0. 0. 0. 0. 0.]
 [0. 0. 0. 0. 0.]]

mindspore.Tensor.scatter(axis, index, src)

根据指定索引将 src 中的值更新到 self 中返回输出。有关更多详细信息，请参阅 mindspore.ops.tensor_scatter_elements() 。

说明

如果src为Tensor，则仅当src的shape和index的shape相同时支持求反向梯度。输入Tensor self 的秩必须至少为1。

参数：

axis (int) - 要进行更新操作的轴。取值范围是[-r, r)，其中r是 self 的秩。
index (Tensor) - 输入Tensor的索引，数据类型为int32或int64的正整数。其rank必须和 self 一致。取值范围是[-s, s)，这里的s是 self 在 axis 指定轴的size。
src (Tensor, float) - 指定对 self 进行更新操作的数据。可以为Tensor，此时其数据类型必须与输入 self 的数据类型相同。也可以是个float类型的标量。

返回：

Tensor，shape和数据类型与输入 self 相同。

异常：

TypeError - index 的数据类型既不是int32，也不是int64。
ValueError - self 、 index 和 src 中，任意一者的秩小于1。
ValueError - src 的秩和 self 的秩不一样。
TypeError - self 的数据类型和 src 的数据类型不一致。
RuntimeError - index 中存在负数。

支持平台：

Ascend GPU CPU

样例：

>>> import numpy as np
>>> import mindspore as ms
>>> from mindspore import Tensor, ops
>>> input = Tensor(np.array([[1, 2, 3, 4, 5]]), dtype=ms.float32)
>>> src = Tensor(np.array([[8, 8]]), dtype=ms.float32)
>>> index = Tensor(np.array([[2, 4]]), dtype=ms.int64)
>>> out = ops.scatter(input=input, axis=1, index=index, src=src)
>>> print(out)
[[1. 2. 8. 4. 8.]]
>>> input = Tensor(np.zeros((5, 5)), dtype=ms.float32)
>>> src = Tensor(np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]]), dtype=ms.float32)
>>> index = Tensor(np.array([[0, 0, 0], [2, 2, 2], [4, 4, 4]]), dtype=ms.int64)
>>> out = ops.scatter(input=input, axis=0, index=index, src=src)
>>> print(out)
[[1. 2. 3. 0. 0.]
 [0. 0. 0. 0. 0.]
 [4. 5. 6. 0. 0.]
 [0. 0. 0. 0. 0.]
 [7. 8. 9. 0. 0.]]
>>> input = Tensor(np.zeros((5, 5)), dtype=ms.float32)
>>> src = Tensor(np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]]), dtype=ms.float32)
>>> index = Tensor(np.array([[0, 2, 4], [0, 2, 4], [0, 2, 4]]), dtype=ms.int64)
>>> out = ops.scatter(input=input, axis=1, index=index, src=src)
>>> print(out)
[[1. 0. 2. 0. 3.]
 [4. 0. 5. 0. 6.]
 [7. 0. 8. 0. 9.]
 [0. 0. 0. 0. 0.]
 [0. 0. 0. 0. 0.]]