Python PyTorch Tensor.scatter_用法及代码示例

本文简要介绍python语言中 torch.Tensor.scatter_ 的用法。

用法:

Tensor.scatter_(dim, index, src, reduce=None) → Tensor

参数：

• dim(int) -索引的轴

• index(LongTensor) -要分散的元素的索引可以为空或与 src 具有相同的维度。当为空时，该操作返回 self 不变。

• src(Tensor或者float) -要分散的源元素。

• reduce(str,可选的) -要应用的缩减操作，可以是 'add' 或 'multiply' 。

将张量 src 中的所有值写入 self 在 index 张量中指定的索引处。对于 src 中的每个值，其输出索引由 src 中的索引指定 dimension != dim 和 index 中的相应值 dimension = dim 。

对于 3-D 张量，self 更新为：

self[index[i][j][k]][j][k] = src[i][j][k]  # if dim == 0
self[i][index[i][j][k]][k] = src[i][j][k]  # if dim == 1
self[i][j][index[i][j][k]] = src[i][j][k]  # if dim == 2

这是 gather() 中说明的方式的相反操作。

self 、 index 和 src (如果是张量)都应该具有相同的维数。还需要 index.size(d) <= src.size(d) 用于所有维度 d ，并且 index.size(d) <= self.size(d) 用于所有维度 d != dim 。请注意，index 和 src 不广播。

此外，对于 gather() ，index的值必须在0和self.size(dim) - 1之间。

警告

当索引不唯一时，行为是不确定的(将任意选取来自src 的值之一)并且梯度将不正确(它将传播到源中对应于相同索引的所有位置) ！

注意

向后传递仅针对 src.shape == index.shape 实施。

此外，还接受一个可选的 reduce 参数，该参数允许指定可选的归约操作，该操作适用于在 index 中指定的索引处将张量 src 中的所有值转换为 self 。对于src 中的每个值，归约操作应用于self 中的索引，该索引由src 中的索引指定dimension != dim 和index 中的相应值指定dimension = dim。

给定一个 3-D 张量并使用乘法运算进行归约，self 更新为：

self[index[i][j][k]][j][k] *= src[i][j][k]  # if dim == 0
self[i][index[i][j][k]][k] *= src[i][j][k]  # if dim == 1
self[i][j][index[i][j][k]] *= src[i][j][k]  # if dim == 2

使用加法操作减少与使用 scatter_add_() 相同。

例子：

>>> src = torch.arange(1, 11).reshape((2, 5))
>>> src
tensor([[ 1,  2,  3,  4,  5],
        [ 6,  7,  8,  9, 10]])
>>> index = torch.tensor([[0, 1, 2, 0]])
>>> torch.zeros(3, 5, dtype=src.dtype).scatter_(0, index, src)
tensor([[1, 0, 0, 4, 0],
        [0, 2, 0, 0, 0],
        [0, 0, 3, 0, 0]])
>>> index = torch.tensor([[0, 1, 2], [0, 1, 4]])
>>> torch.zeros(3, 5, dtype=src.dtype).scatter_(1, index, src)
tensor([[1, 2, 3, 0, 0],
        [6, 7, 0, 0, 8],
        [0, 0, 0, 0, 0]])

>>> torch.full((2, 4), 2.).scatter_(1, torch.tensor([[2], [3]]),
...            1.23, reduce='multiply')
tensor([[2.0000, 2.0000, 2.4600, 2.0000],
        [2.0000, 2.0000, 2.0000, 2.4600]])
>>> torch.full((2, 4), 2.).scatter_(1, torch.tensor([[2], [3]]),
...            1.23, reduce='add')
tensor([[2.0000, 2.0000, 3.2300, 2.0000],
        [2.0000, 2.0000, 2.0000, 3.2300]])