torch.Tensor.scatter_¶
- Tensor.scatter_(dim, index, src, *, reduce=None) Tensor ¶
将张量
src
中的所有值写入self
中,索引由index
张量中指定的索引决定。对于src
中的每个值,其输出索引由其在src
中的索引(对于dimension != dim
)以及index
中的对应值(对于dimension = dim
)决定。对于 3 维张量,
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
参数,该参数允许指定可选的缩减操作,该操作应用于张量src
中的所有值到self
中,索引由index
指定。对于src
中的每个值,缩减操作应用于self
中的索引,该索引由其在src
中的索引(对于dimension != dim
)以及index
中的对应值(对于dimension = dim
)决定。给定 3 维张量和使用乘法运算进行缩减,
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
的 reduce 参数已弃用,将在未来的 PyTorch 版本中移除。请改用scatter_reduce_()
以获得更多缩减选项。- 参数
- 关键字参数
reduce (str, 可选) – 要应用的归约操作,可以是
'add'
或'multiply'
。
示例
>>> 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]])
- scatter_(dim, index, value, *, reduce=None) Tensor:
将
value
中的值写入self
中,索引由index
张量指定。此操作等效于先前版本,其中src
张量完全填充为value
。- 参数
dim (int) – 沿着该轴进行索引
index (LongTensor) – 要散射的元素的索引,可以为空或与
src
的维度相同。为空时,操作返回self
不变。value (Scalar) – 要散射的值。
- 关键字参数
reduce (str, 可选) – 要应用的归约操作,可以是
'add'
或'multiply'
。
示例
>>> index = torch.tensor([[0, 1]]) >>> value = 2 >>> torch.zeros(3, 5).scatter_(0, index, value) tensor([[2., 0., 0., 0., 0.], [0., 2., 0., 0., 0.], [0., 0., 0., 0., 0.]])