PyTorch torch.scatter_reduce 関数

Pytorch torch リファレンスマニュアル

torch.scatter_reducePyTorchにおいて、ソーステンソルの値を指定された方法で指定された位置に集約するための関数です。合計、積、最大値、最小値など、複数の集約方法をサポートしています。

関数定義

torch.scatter_reduce(input, dim, index, src, reduce='sum', *, include_self=True)

パラメータ:

• input(Tensor): 入力テンソル。
• dim(int): 集約する次元。
• index(Tensor): インデックステンソル。srcの値をinputのどの位置に集約するかを指定します。
• src(Tensor): ソーステンソル。集約する値です。
• reduce(str): 集約方法。指定可能な値は'sum'、'prod'、'mean'、'amax'、'amin'、'multiply'です。デフォルトは'sum'です。
• include_self(bool, オプション): 集約時にインデックス位置自体の元の値を含めるかどうか。デフォルトはTrueです。

戻り値:

• torch.Tensor: 集約後のテンソルを返します。

使用例

出力結果は次のとおりです：

输入:
tensor([[1., 1., 1., 1., 1.],
        [1., 1., 1., 1., 1.],
        [1., 1., 1., 1., 1.]])

聚合方式: sum
结果:
tensor([[4., 2., 3., 4., 4.],
        [2., 2., 2., 2., 2.],
        [3., 3., 2., 3., 3.]])

出力結果は次のとおりです：

prod 聚合:
tensor([[ 2.,  3.,  4.],
        [ 5.,  6.,  7.],
        [ 8.,  9., 10.]])

amax 聚合:
tensor([[ 2.,  3.,  4.],
        [ 5.,  6.,  7.],
        [ 8.,  9., 10.]])

amin 聚合:
tensor([[ 2.,  3.,  4.],
        [ 5.,  6.,  7.],
        [ 8.,  9., 10.]])

出力結果は次のとおりです：

include_self=True: tensor([66.,  2.,  3.])
include_self=False: tensor([60.,  2.,  3.])

注意：torch.scatter_reduce元の入力テンソルは変更されず、新しいテンソルが返されます。複数のインデックスが同じ位置を指すことができ、値は指定された集約方法に従って集約されます。include_self=False特定のシナリオで役立ちます。例えば、グラフニューラルネットワークにおいてノード自身の特徴を重複して計算するのを防ぐ場合などです。

Pytorch torch リファレンスマニュアル