pytorch_scatter

pytorch散射

---

文档

该软件包由一个小型扩展库组成，该库具有高度优化的稀疏更新（散点和段）操作，用于Pytorch中的使用，这些库在主包中缺少。散射和段操作可以大致描述为基于给定的“组索引”张量的减少操作。细分操作要求对“组索引”张量进行排序，而散点操作则不受这些要求的约束。

该软件包由以下操作组成，带有减少类型"sum"|"mean"|"min"|"max" ：

• 根据任意指标散射
• 基于排序索引
• 基于压缩指数的sement_csr

此外，我们还提供以下复合功能，可利用scatter_*在引擎盖下的操作： scatter_std ， scatter_logsumexp ， scatter_softmax和scatter_log_softmax 。

所有随附的操作都是可广播的，在不同的数据类型上进行的工作，并针对CPU和GPU实施，并具有相应的向后实现，并且完全可追溯。

安装

Anaconda

更新：您现在可以通过Anaconda安装pytorch-scatter以适用于所有主要的OS/Pytorch/CUDA组合？鉴于您安装了pytorch >= 1.8.0 ，只需运行

 conda install pytorch-scatter -c pyg

二进制

或者，我们为所有主要的OS/Pytorch/CUDA组合提供PIP轮毂，请参见此处。

Pytorch 2.5

要安装Pytorch 2.5.0的二进制文件，只需运行

 pip install torch-scatter -f https://data.pyg.org/whl/torch-2.5.0+${CUDA}.html

${CUDA}应取代cpu ， cu118 ， cu121或cu124 ，具体取决于您的pytorch安装。

	cpu	cu118	cu121	cu124
Linux	✅	✅	✅	✅
视窗	✅	✅	✅	✅
macos	✅

Pytorch 2.4

要安装Pytorch 2.4.0的二进制文件，只需运行

 pip install torch-scatter -f https://data.pyg.org/whl/torch-2.4.0+${CUDA}.html

${CUDA}应取代cpu ， cu118 ， cu121或cu124 ，具体取决于您的pytorch安装。

	cpu	cu118	cu121	cu124
Linux	✅	✅	✅	✅
视窗	✅	✅	✅	✅
macos	✅

Note: Binaries of older versions are also provided for PyTorch 1.4.0, PyTorch 1.5.0, PyTorch 1.6.0, PyTorch 1.7.0/1.7.1, PyTorch 1.8.0/1.8.1, PyTorch 1.9.0, PyTorch 1.10.0/1.10.1/1.10.2, PyTorch 1.11.0, PyTorch 1.12.0/1.12.1，Pytorch 1.13.0/1.13.1，Pytorch 2.0.0/2.0.1，Pytorch 2.1.0/2.1.1.1/2.1.2，Pytorch 2.2.0/2.2.1.2.1.2.1/2.2.2，以及Pytorch 2.3.0/2.3.0/2.3.0/2.3.1/2.3.1（遵循同一过程）。对于较旧的版本，您需要明确指定最新的支持版本号，或通过pip install --no-index安装，以防止源头安装手动安装。您可以在此处查找最新支持的版本号。

来自来源

确保安装了至少Pytorch 1.4.0，并验证cuda/bin and cuda/include分别在您的$PATH和$CPATH中，例如：

 $ python -c "import torch; print(torch.__version__)"
>>> 1.4.0

$ echo $PATH
>>> /usr/local/cuda/bin:...

$ echo $CPATH
>>> /usr/local/cuda/include:...

然后运行：

 pip install torch-scatter

当在没有NVIDIA驱动程序的Docker容器中运行时，Pytorch需要评估计算功能，并且可能会失败。在这种情况下，请确保通过TORCH_CUDA_ARCH_LIST设置计算功能，例如：

 export TORCH_CUDA_ARCH_LIST = "6.0 6.1 7.2+PTX 7.5+PTX"

例子

 import torch
from torch_scatter import scatter_max

src = torch . tensor ([[ 2 , 0 , 1 , 4 , 3 ], [ 0 , 2 , 1 , 3 , 4 ]])
index = torch . tensor ([[ 4 , 5 , 4 , 2 , 3 ], [ 0 , 0 , 2 , 2 , 1 ]])

out , argmax = scatter_max ( src , index , dim = - 1 )

 print(out)
tensor([[0, 0, 4, 3, 2, 0],
        [2, 4, 3, 0, 0, 0]])

print(argmax)
tensor([[5, 5, 3, 4, 0, 1]
        [1, 4, 3, 5, 5, 5]])

运行测试

 pytest

C ++ API

torch-scatter还提供了一个C ++ API，其中包含python模型的C ++。为此，我们需要将TorchLib添加到-DCMAKE_PREFIX_PATH （例如，它可能存在于{CONDA}/lib/python{XX}/site-packages/torch中，如果通过conda安装）：

 mkdir build
cd build
# Add -DWITH_CUDA=on support for CUDA support
cmake -DCMAKE_PREFIX_PATH="..." ..
make
make install