mindspore.ops.scatter

View Source On Gitee
mindspore.ops.scatter(input, axis, index, src)[source]

Update the value in src to input according to the specified index. Refer to mindspore.ops.tensor_scatter_elements() for more details.

Note

The backward is supported only for the case src.shape == index.shape.

Parameters

  • input (Tensor) – The target tensor. The rank of input must be at least 1.

  • axis (int) – Which axis to scatter. Accepted range is [-r, r) where r = rank(input).

  • index (Tensor) – The index to do update operation whose data must be positive number with type of mindspore.int32 or mindspore.int64. Same rank as input . And accepted range is [-s, s) where s is the size along axis.

  • src (Tensor, float) – The data doing the update operation with input. Can be a tensor with the same data type as input or a float number to scatter.

Returns

The backward is supported only for the case src.shape == index.shape when src is a tensor.

Raises

  • TypeError – If index is neither int32 nor int64.

  • ValueError – If rank of any of input , index and src less than 1.

  • ValueError – If the rank of src is not equal to the rank of input .

  • TypeError – If the data type of input and src have different dtypes.

  • RuntimeError – If index has negative elements.

Supported Platforms:

Ascend GPU CPU

Examples

>>> 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.]]