torch.Tensor.scatter_

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

Записывает все значения из тензора 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().

Также требуется, чтобы index.size(d) <= src.size(d) для всех измерений d, а также чтобы index.size(d) <= self.size(d) для всех измерений d != dim. Обратите внимание, что input и index не поддерживают broadcasting друг с другом для NPU, поэтому при выполнении на NPU input и index должны иметь одинаковое число измерений. Во всех остальных случаях применяется стандартный broadcasting.

Кроме того, как и для 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-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_().

Предупреждение

Аргумент reduce для Tensor src устарел и будет удалён в будущей версии PyTorch. Вместо него используйте scatter_reduce_(), который поддерживает больше вариантов редукции.

Параметры:

• dim (int) – ось, вдоль которой выполняется индексация
• index (LongTensor) – индексы элементов для записи; может быть пустым или иметь ту же размерность, что и src. Если он пуст, операция возвращает self без изменений.
• src (Tensor) – исходный элемент или элементы для записи.

Именованные аргументы:

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 в self по индексам, указанным в тензоре index. Эта операция эквивалентна предыдущей версии, в которой тензор src полностью заполнен значением value.

Параметры:

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