DeepSNAP

文档 | 示例 | Colab 笔记本

DeepSNAP 是一个用于高效图深度学习的 Python 库。它支持灵活的图操作、标准工作流程、异构图以及简洁的 API。

DeepSNAP 桥接了强大的图处理库（如 NetworkX）和深度学习框架 PyTorch Geometric。凭借直观且易于使用的 API，DeepSNAP 解决了以下痛点：

• DeepSNAP 目前支持基于 NetworkX 的后端（对于同质无向图还支持 SnapX 后端），允许用户无缝调用数百种图算法来操作或转换图结构，甚至可以在每个训练迭代中进行。
• DeepSNAP 提供了数据集划分、负采样以及定义节点/边/图级别目标的标准工作流程，这些对用户来说都是透明的。
• DeepSNAP 为灵活且通用的异构 GNN 提供了高效的支撑，既支持节点异构性也支持边异构性，并允许用户控制消息的参数化方式及传递过程。
• DeepSNAP 拥有简单易用的 API，能够与现有基于 PyTorch Geometric 实现的 GNN 模型和数据集无缝衔接。如果用户已经熟悉 PyTorch Geometric，则几乎无需额外学习。

安装

要安装 DeepSNAP，请确保已安装 PyTorch Geometric 和 NetworkX。然后执行以下命令：

$ pip install deepsnap

或者从源码构建：

$ git clone https://github.com/snap-stanford/deepsnap
$ cd deepsnap
$ pip install .

示例

代码仓库中提供了使用 DeepSNAP 的示例。

$ git clone https://github.com/snap-stanford/deepsnap

节点分类：

$ cd deepsnap/examples/node_classification # 节点分类
$ python node_classification_planetoid.py

链接预测：

$ cd deepsnap/examples/link_prediction # 链接预测
$ python link_prediction_cora.py

图分类：

$ cd deepsnap/examples/graph_classification # 图分类
$ python graph_classification_TU.py

文档

有关全面的概述、介绍、教程和示例，请参阅 完整文档。

DeepSNAP 快速上手指南

DeepSNAP 是一个用于高效图深度学习的 Python 库。它桥接了强大的图操作库 NetworkX 和深度学习框架 PyTorch Geometric (PyG)，提供了灵活的图操纵、标准化的数据处理流水线以及对异构图的原生支持。

环境准备

在安装 DeepSNAP 之前，请确保您的系统已安装以下依赖：

• Python: 建议 Python 3.7+
• PyTorch: 需预先安装与您的 CUDA 版本匹配的 PyTorch。
• PyTorch Geometric: DeepSNAP 的核心依赖。
• NetworkX: 用于后端图操作。

提示：如果您尚未安装 PyTorch Geometric，请参考其官方文档或使用以下命令（以 CPU 版本为例，GPU 版本请根据官网指引安装对应 wheel）：

pip install torch-scatter torch-sparse torch-cluster torch-spline-conv torch-geometric -f https://data.pyg.org/whl/torch-1.13.0+cpu.html

(注：请将上述链接中的 torch 版本替换为您实际安装的版本)

安装步骤

您可以选择通过 PyPI 直接安装，或从源码构建。

方式一：使用 pip 安装（推荐）

pip install deepsnap

方式二：从源码安装

如果您需要最新的功能或进行开发，可以从 GitHub 克隆源码安装：

git clone https://github.com/snap-stanford/deepsnap
cd deepsnap
pip install .

基本使用

DeepSNAP 的 API 设计与 PyTorch Geometric 高度兼容，上手成本极低。以下展示如何获取示例代码并运行一个最简单的节点分类任务。

1. 获取示例代码

git clone https://github.com/snap-stanford/deepsnap
cd deepsnap/examples/node_classification

2. 运行节点分类示例

DeepSNAP 内置了基于 Planetoid 数据集（如 Cora, Citeseer, Pubmed）的节点分类示例。直接运行以下脚本即可启动训练：

python node_classification_planetoid.py

3. 代码逻辑简析

在该示例中，DeepSNAP 展示了其核心优势：

• 无缝转换：自动将 NetworkX 图转换为 PyG 可用的格式。
• 标准化流水线：自动处理数据集划分、负采样等步骤。
• 灵活操作：允许在训练的每个迭代中对图进行动态变换。

如需尝试其他任务，可参考以下命令：

链接预测 (Link Prediction):

cd ../link_prediction
python link_prediction_cora.py

图分类 (Graph Classification):

cd ../graph_classification
python graph_classification_TU.py

更多详细教程、API 文档及 Colab 笔记，请访问 DeepSNAP 官方文档。