torch.Tensor.scatter_¶
- Tensor.scatter_(dim, index, src, *, reduce=None) Tensor¶
將張量
src中的所有值，根據index張量指定的索引位置，寫入到self中。對於src中的每個值，其輸出索引由它在src中的索引決定，當dimension != dim時；而當dimension = dim時，則由index中的對應值決定。對於一個 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(如果它是 Tensor) 應該具有相同的維度數。 此外，對於所有維度d，必須滿足index.size(d) <= src.size(d)，且對於所有維度d != dim，必須滿足index.size(d) <= self.size(d)。 請注意，index和src不進行廣播 (broadcast)。此外，與
gather()類似，index的值必須介於0和self.size(dim) - 1(包含) 之間。警告
當索引不是唯一時，行為是不確定的（將任意選擇
src中的其中一個值），並且梯度將是不正確的（它將傳播到源中對應於相同索引的所有位置）！注意
反向傳播僅針對
src.shape == index.shape實作。另外，接受一個可選的
reduce參數，允許指定一個可選的歸約運算，該運算應用於張量src中的所有值，寫入到self中，位置由index指定。 對於src中的每個值，歸約運算應用到self中的一個索引，該索引由其在src中的索引決定，如果dimension != dim，索引就是src中的索引。如果dimension = dim，索引就是index中的對應值。給定一個 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_()相同。警告
帶有 Tensor
src的 reduce 參數已被棄用，將在未來的 PyTorch 版本中移除。 請改用scatter_reduce_()以獲得更多歸約選項。- 參數
- 關鍵字參數
reduce (str, optional) – 要應用的歸約運算，可以是
'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中的值，根據index張量指定的索引位置，寫入到self中。 此操作等同於先前的版本，只是src張量完全填充了value。- 參數
dim (int) – 要沿其索引的軸。
index (LongTensor) – 要分散 (scatter) 元素的索引，可以是空的，也可以與
src具有相同的維度。 為空時，該操作返回未更改的self。value (Scalar) – 要分散的值。
- 關鍵字參數
reduce (str, optional) – 要應用的歸約運算，可以是
'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.]])
