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_().

Параметры:

• dim (int) – ось, по которой производится индексирование
• index (LongTensor) – индексы элементов для рассеивания, могут быть пустыми или иметь такую же размерность, как src. Если пустые, операция возвращает self без изменений.
• src (Tensor или float) – элемент(ы) источника для рассеивания.
• 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]])