PopTorch 和 PopTorch Geometric

PopTorch - 用于 Graphcore IPU 的 PyTorch 集成

PopTorch 是一套 PyTorch 扩展，使模型能够在 Graphcore IPU 上进行训练、评估和使用。

更多信息可以在 PopTorch 用户指南中找到。

PopTorch Geometric - 用于 Graphcore IPU 的 PyTorch Geometric 集成

PopTorch Geometric 是一套 PyTorch Geometric 扩展，使图神经网络模型能够在 Graphcore IPU 上进行训练、评估和使用。PopTorch Geometric 依赖于 PopTorch 提供的功能。

更多信息可以在 PopTorch Geometric 用户指南中找到。

先决条件

这些说明假设你在 Ubuntu 20.04 上构建 PopTorch 和 PopTorch Geometric。

要安装和运行 PopTorch 和 PopTorch Geometric，你需要：

Python 3.8
pip3 >= 18.1
Poplar SDK

sudo apt install -y python3 python3-pip

要从源代码构建 PopTorch 和 PopTorch Geometric，除了上述条件外，你还需要：

git
curl
g++

sudo apt install -y git curl g++

要构建文档，你还需要 LaTeX：

sudo apt install -y texlive-full

安装 Poplar SDK

可以从以下地址下载 Poplar SDK：https://www.graphcore.ai/downloads

设置以下环境变量以指向已安装的 Poplar SDK：

export SDK_PATH=/path/to/poplar_sdk-ubuntu_20_04*

PopTorch 必须与兼容版本的 SDK 一起构建。例如，PopTorch 的 "sdk-release-3.2" 分支必须与 Poplar SDK 3.2 一起构建。

安装

确保 pip3 是最新版本（你需要 pip3 >= 18.1）：

pip3 install -U pip --user

安装 PopTorch wheel（Torch 将在此过程中自动安装）：

pip3 install ${SDK_PATH}/poptorch-*.whl

一旦 PopTorch wheel 安装完成，如果需要，可以安装 PopTorch Geometric wheel（PyTorch Geometric 将在此过程中自动安装）：

pip3 install ${SDK_PATH}/poptorch_geometric-*.whl

使用

PopTorch wheel 不包含 PopART 和 Poplar 二进制文件，所以在加载 PopTorch 或 PopTorch Geometric 之前，你需要确保它们在你的路径中。这可以通过执行它们各自的 enable.sh 脚本来完成：

. ${SDK_PATH}/poplar-ubuntu_20_04*/enable.sh
. ${SDK_PATH}/popart-ubuntu_20_04*/enable.sh

你可以通过运行以下命令来检查一切是否正常：

python3 -c "import poptorch;print(poptorch.__version__)"

同样适用于 PopTorch Geometric：

python3 -c "import poptorch_geometric;print(poptorch_geometric.__version__)"

更多信息可以在 PopTorch 用户指南中找到。

构建说明

我们使用 Mambaforge 作为构建环境管理器。

克隆 PopTorch 仓库

git clone https://github.com/graphcore/poptorch.git

创建一个用于构建的文件夹

mkdir build
cd build

创建构建环境并安装依赖项

../poptorch/scripts/create_buildenv.py

激活构建环境

. activate_buildenv.sh

配置构建

cmake ../poptorch -DSDK_DIR=${SDK_PATH} -GNinja

默认情况下，PopTorch 将以发布模式构建。要以调试模式构建，请添加 -DCMAKE_BUILD_TYPE=Debug。

要构建文档，请添加 -DBUILD_DOCS=ON。HTML 和 PDF 文档将生成在 docs/ 目录中。

编译 PopTorch 和 PopTorch Geometric 库

ninja install

如果你只打算将 PopTorch 或 PopTorch Geometric 用于开发目的，那么到这里就可以停止了。在 PopTorch 构建文件夹中执行 enable 脚本，然后你就可以开始使用 PopTorch：

. enable.sh
python3 -c "import poptorch;print(poptorch.__version__)"

同样适用于 PopTorch Geometric：

. enable.sh
python3 -c "import poptorch_geometric;print(poptorch_geometric.__version__)"

（可选）构建 PopTorch wheel 包

ninja poptorch_wheel

wheel 包将创建在 install/dist 目录中。

（可选）构建 PopTorch Geometric wheel 包

ninja poptorch_geometric_wheel

wheel 包将创建在 install/dist 目录中。

运行测试

要运行测试：

# 运行所有测试，仅在失败时打印输出，并行运行 80 个测试
./test.sh -j80
# PopTorch 有 3 个测试标签：examples、short、long。要运行除 long 之外的所有测试：
./test.sh -j80 -LE long
# 仅运行 short 测试
./test.sh -j80 -L short
# 使用 -R 按名称筛选测试
./test.sh -j80 -R half_
# 获取更多信息：
./test.sh --help

注意：如果你并行运行测试，请确保告诉 PopTorch 在所有 IPU 都在使用时等待一个 IPU 可用：

export POPTORCH_WAIT_FOR_IPU=1

也可以使用 pytest 单独运行测试：

. enable.sh
python3 -m pytest ../poptorch/tests/options_test.py
# 添加 -s 以获取完整输出
# 使用 -k 按名称筛选测试
python3 -m pytest ../poptorch/tests/options_test.py -s -k popart

图神经网络特定的测试位于 tests/gnn/ 子目录中：

. enable.sh
python3 -m pytest ../poptorch/tests/gnn/test_basic_gnn.py
# 添加 -s 以获取完整输出
# 使用 -k 按名称筛选测试
python3 -m pytest ../poptorch/tests/gnn/test_basic_gnn.py -s -k GraphSAGE