OpenHGNN

启智社区（中文版） | OpenHGNN [CIKM2022] | Space4HGNN [SIGIR2022] | Benchmark&Leaderboard | Slack 频道

这是一个基于 DGL [深度图库] 和 PyTorch 的异构图神经网络开源工具包。我们集成了当前最先进的异构图模型。

新闻

2024-07-23 发布 v0.7

我们发布了最新版本 v0.7.0：

• 新模型和数据集。
• 图提示流水线。
• 数据处理框架：dgl.graphBolt。
• 新的 GNN 聚合器：dgl.sparse。
• 分布式训练。

2023-07-17 发布 v0.5

我们发布了最新版本 v0.5.0：

• 新模型和数据集。
• 4 个新任务：预训练、推荐系统、图攻击与防御以及异常事件检测。
• TensorBoard 可视化。
• 维护和测试模块。

2023-02-24 OpenI 优秀孵化奖

OpenHGNN 获得了 OpenI 社区的优秀孵化项目奖！更多详情请见：https://mp.weixin.qq.com/s/PpbwEdP0-8wG9dsvRvRDaA

2023-02-21 CIE 一等奖

该算法库支持由北京邮电大学牵头，蚂蚁集团、中国移动、海致科技等参与的“大规模复杂异构图数据智能分析技术及规模化应用”项目。该项目荣获 2022 年中国电子学会“科技进步一等奖”。

2023-01-13 发布 v0.4

我们发布了最新版本 v0.4。

• 新模型。
• 提供应用流水线。
• 更多支持小批量训练的模型。
• 百万级图的基准测试。

2022-08-02 论文被接受

我们的论文 [ OpenHGNN：一个用于异构图神经网络的开源工具包 ](https://dl.acm.org/doi/abs/10.1145/3511808.3557664) 被 CIKM 2022 短文赛道接受。

2022-06-27 发布 v0.3

我们发布了最新版本 v0.3。

• 新模型。
• API 使用说明。
• 简单自定义用户数据集和模型。
• 异构图可视化工具。

2022-02-28 发布 v0.2

我们发布了最新版本 v0.2。

• 新模型。
• Space4HGNN [SIGIR2022]。
• Benchmark&Leaderboard。

2022-01-07 加入启智社区

启智社区用户可以享受到如下功能：

• 全新的中文文档。
• 免费的计算资源—— 云脑使用教程
• OpenHGNN 最新功能
  • 新增模型：【KDD2017】Metapath2vec、【TKDE2018】HERec、【KDD2021】HeCo、【KDD2021】SimpleHGN、【TKDE2021】HPN、【ICDM2021】HDE、fastGTN
  • 新增日志功能。
  • 新增美团外卖数据集。

核心特性

• 易于使用：OpenHGNN 提供了易于使用的接口，方便用户使用提供的模型和数据集进行实验。此外，我们还集成了 optuna 来实现超参数优化。
• 可扩展性：用户可以自定义任务/模型/数据集，将新模型应用于新场景。
• 高效性：后端的 dgl 提供高效的 API。

开始使用

要求与安装

• Python >= 3.6

• PyTorch >= 2.3.0

• DGL >= 2.2.1

• CPU 或 NVIDIA GPU，Linux，Python3

1. Python 环境（可选）： 我们建议使用 Conda 包管理器

conda create -n openhgnn python=3.6
source activate openhgnn

2. 安装 PyTorch： 按照他们的 教程 根据您的操作系统和 CUDA 版本运行相应的命令。例如：

pip install torch torchvision torchaudio

3. 安装 DGL： 按照他们的 教程 根据您的操作系统和 CUDA 版本运行相应的命令。例如：

pip install dgl -f https://data.dgl.ai/wheels/repo.html

4. 安装 openhgnn：

• 从 pypi 安装

pip install openhgnn

• 从源代码安装

git clone https://github.com/BUPT-GAMMA/OpenHGNN
# 如果遇到网络错误，可以尝试从 openi 克隆以下仓库。

# 克隆代码库
git clone https://git.openi.org.cn/GAMMALab/OpenHGNN.git
cd OpenHGNN
pip install .

5. 安装 gdbi（可选）：

• 从 Git 安装 gdbi

pip install git+https://github.com/xy-Ji/gdbi.git

• 从 PyPI 安装图数据库

pip install neo4j==5.16.0
pip install nebula3-python==3.4.0

在现有基准数据集上运行现有基线模型 数据集

python main.py -m 模型名称 -d 数据集名称 -t 任务名称 -g 0 --use_best_config --load_from_pretrained

用法：main.py [-h] [--model MODEL] [--task TASK] [--dataset DATASET] [--gpu GPU] [--use_best_config][--use_database]

可选参数：

-h, --help 显示此帮助信息并退出

--model -m 模型名称

--task -t 任务名称

--dataset -d 数据集名称

--gpu -g 控制使用的 GPU。如果没有 GPU，请设置 -g -1。

--use_best_config use_best_config 表示可以使用该数据集与模型的最佳配置。如果想要设置不同的超参数，可以手动修改 openhgnn.config.ini 文件。best_config 会覆盖 config.ini 中的参数。

--load_from_pretrained 将从默认检查点加载模型。

--use_database 从数据库获取数据集

---mini_batch_flag 使用小批量训练模型

---graphbolt 使用 dgl.graphbolt 进行小批量训练

---use_distributed 以分布式方式训练模型

例如：

python main.py -m GTN -d imdb4GTN -t node_classification -g 0 --use_best_config

python main.py -m RGCN -d imdb4GTN -t node_classification -g 0 --mini_batch_flag --graphbolt

注意：如果您对某些模型感兴趣，可以参考下面的模型列表。

请参阅 文档 以获取更多基础和深入的使用说明。

使用 TensorBoard 可视化训练结果

tensorboard --logdir=./openhgnn/output/{模型名称}/

例如：

tensorboard --logdir=./openhgnn/output/RGCN/

注意：要进行结果可视化，您需要先训练模型。

使用 gdbi 获取图数据集

以 neo4j 和 imdb 数据集为例：

• 构建数据集的 CSV 文件（节点级：A.csv，边级：A_P.csv）
• 将 CSV 文件导入数据库

LOAD CSV WITH HEADERS FROM "file:///data.csv" AS row
CREATE (:graphname_labelname {ID: row.ID, ... });

• 在 config.py 文件中添加访问数据库的用户信息

self.graph_address = [图数据库地址]
self.user_name = [用户名]
self.password = [密码]

• 例如：

python main.py -m MAGNN -d imdb4MAGNN -t node_classification -g 0 --use_best_config --use_database

模型

支持特定任务的模型

该链接将提供一些基本用法。

模型	节点分类	链接预测	推荐系统
TransE[NIPS 2013]		:heavy_check_mark:
TransH[AAAI 2014]		:heavy_check_mark:
TransR[AAAI 2015]		:heavy_check_mark:
TransD[ACL 2015]		:heavy_check_mark:
Metapath2vec[KDD 2017]	:heavy_check_mark:
RGCN[ESWC 2018]	:heavy_check_mark:	:heavy_check_mark:
HERec[TKDE 2018]	:heavy_check_mark:
HAN[WWW 2019]	:heavy_check_mark:	:heavy_check_mark:
KGCN[WWW 2019]			:heavy_check_mark:
HetGNN[KDD 2019]	:heavy_check_mark:	:heavy_check_mark:
HeGAN[KDD 2019]	:heavy_check_mark:
HGAT[EMNLP 2019]
GTN[NeurIPS 2019] & fastGTN	:heavy_check_mark:
RSHN[ICDM 2019]	:heavy_check_mark:	:heavy_check_mark:
GATNE-T[KDD 2019]		:heavy_check_mark:
DMGI[AAAI 2020]	:heavy_check_mark:
MAGNN[WWW 2020]	:heavy_check_mark:
HGT[WWW 2020]	:heavy_check_mark:
CompGCN[ICLR 2020]	:heavy_check_mark:	:heavy_check_mark:
NSHE[IJCAI 2020]	:heavy_check_mark:
NARS[arxiv]	:heavy_check_mark:
MHNF[arxiv]	:heavy_check_mark:
HGSL[AAAI 2021]	:heavy_check_mark:
HGNN-AC[WWW 2021]	:heavy_check_mark:
HeCo[KDD 2021]	:heavy_check_mark:
SimpleHGN[KDD 2021]	:heavy_check_mark:
HPN[TKDE 2021]	:heavy_check_mark:	:heavy_check_mark:
RHGNN[arxiv]	:heavy_check_mark:
HDE[ICDM 2021]		:heavy_check_mark:
HetSANN[AAAI 2020]	:heavy_check_mark:
ieHGCN[TKDE 2021]	:heavy_check_mark:
KTN[NIPS 2022]	:heavy_check_mark:

备选模型

• 用于半监督短文本分类的异构图注意力网络[EMNLP 2019]
• 带有对抗解纠缠器的异构信息网络嵌入[TKDE 2021]

贡献者

OpenHGNN团队[GAMMA实验室]、DGL团队以及鹏城实验室。

更多信息请参阅CONTRIBUTING。

引用 OpenHGNN

如果您在科学出版物中使用了 OpenHGNN，我们非常感谢您引用以下论文：

@inproceedings{han2022openhgnn,
  title={OpenHGNN: 一个用于异构图神经网络的开源工具包},
  author={韩辉、赵天宇、杨成、张宏毅、刘耀奇、王肖、史川},
  booktitle={CIKM},
  year={2022}
}

OpenHGNN 快速上手指南

OpenHGNN 是一个基于 DGL (Deep Graph Library) 和 PyTorch 的开源异构图神经网络工具包，集成了多种 SOTA 模型，支持节点分类、链接预测、推荐系统等任务。

1. 环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统: Linux
• 硬件: CPU 或 NVIDIA GPU
• Python: >= 3.6 (推荐使用 Conda 管理环境)
• PyTorch: >= 2.3.0
• DGL: >= 2.2.1

2. 安装步骤

建议按顺序执行以下步骤以完成环境配置。

2.1 创建 Python 环境（可选但推荐）

使用 Conda 创建独立环境：

conda create -n openhgnn python=3.6
source activate openhgnn

2.2 安装 PyTorch

请访问 PyTorch 官网 根据您的 CUDA 版本选择对应命令。示例：

pip install torch torchvision torchaudio

2.3 安装 DGL

请访问 DGL 安装页面 选择对应命令。示例：

pip install dgl -f https://data.dgl.ai/wheels/repo.html

2.4 安装 OpenHGNN

您可以选择从 PyPI 直接安装，或从源码安装（国内用户推荐从启智社区镜像克隆源码）。

方式一：从 PyPI 安装

pip install openhgnn

方式二：从源码安装（推荐）

# 如果 GitHub 连接超时，请使用下方的启智社区镜像
# git clone https://git.openi.org.cn/GAMMALab/OpenHGNN.git
git clone https://github.com/BUPT-GAMMA/OpenHGNN
cd OpenHGNN
pip install .

2.5 安装图数据库支持（可选）

如果您需要使用 gdbi 模块从 Neo4j 或 Nebula Graph 加载数据：

pip install git+https://github.com/xy-Ji/gdbi.git
pip install neo4j==5.16.0
pip install nebula3-python==3.4.0

3. 基本使用

安装完成后，您可以直接运行内置的基准模型和数据集。

3.1 运行示例

以下命令演示了如何使用 GTN 模型在 imdb4GTN 数据集上进行 节点分类 任务，并自动加载最佳超参数配置：

python main.py -m GTN -d imdb4GTN -t node_classification -g 0 --use_best_config

若需使用 Mini-batch 训练（配合 DGL GraphBolt）：

python main.py -m RGCN -d imdb4GTN -t node_classification -g 0 --mini_batch_flag --graphbolt

3.2 常用参数说明

• -m, --model: 模型名称 (如 RGCN, HAN, MAGNN)
• -d, --dataset: 数据集名称
• -t, --task: 任务类型 (如 node_classification, link_prediction)
• -g, --gpu: 指定 GPU 编号，若无 GPU 则设为 -1
• --use_best_config: 使用该模型在特定数据集上的最佳预设配置
• --load_from_pretrained: 加载预训练权重
• --use_database: 从图数据库加载数据集

3.3 可视化训练结果

训练完成后，可使用 TensorBoard 查看日志：

tensorboard --logdir=./openhgnn/output/{model_name}/

例如查看 RGCN 的结果：

tensorboard --logdir=./openhgnn/output/RGCN/

提示：更多支持的模型列表及详细用法，请参阅 官方文档。