Home

Awesome

异质图神经网络开源工具包

GitHub release (latest by date) Documentation Status GitHub visitors Total lines

启智社区(中文版)Github Community (English)Space4HGNN [SIGIR2022]Benchmark&Leaderboard | Slack Channel

OpenHGNN是一个基于 DGL [Deep Graph Library]PyTorch 的开源异质图神经网络工具包,集成了异质图神经网络的前沿模型。

新闻

<details> <summary> 2024-07-23 开源0.7版本 </summary> <br/>

我们开源了0.7版本

</details> <details> <summary> 2023-07-17 开源0.5版本 </summary> <br/>

我们开源了0.5版本。

</details> <details> <summary> 2023-02-24 优秀孵化奖 </summary> <br/>

OpenHGNN荣获启智社区优秀孵化项⽬奖!详细链接:https://mp.weixin.qq.com/s/PpbwEdP0-8wG9dsvRvRDaA

</details> <details> <summary> 2023-02-21 中国电子学会科技进步一等奖 </summary> <br/>

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

</details> <details> <summary> 2023-01-13 开源0.4版本 </summary> <br/>

我们开源了0.4版本。

</details> <details> <summary> 2022-08-02 论文接收 </summary> <br/>

我们的论文 <i>OpenHGNN: An Open Source Toolkit for Heterogeneous Graph Neural Network</i> 在CIKM2022 short paper track接收。

</details> <details> <summary> 2022-06-27 开源0.3版本 </summary> <br/>

我们开源了0.3版本。

</details> <details> <summary> 2022-02-28 开源0.2版本 </summary> <br/>

我们开源了0.2版本。

</details> <details> <summary> 2022-01-07 加入启智社区 </summary> <br/> 启智社区用户可以享受到如下功能:

关键特性

开始使用

环境要求

1. Python 环境 (可选): 推荐使用 Conda 包管理

conda create -n openhgnn python=3.6
source activate openhgnn

2. 安装Pytorch: 参考 PyTorch安装文档 根据你的操作系统和CUDA版本选择合适的安装命令。例如:

pip install torch torchvision torchaudio

3. 安装DGL: 参考 DGL安装文档 根据你的操作系统和CUDA版本选择合适的安装命令。例如:

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

4. 安装 openhgnn:

pip install openhgnn
git clone https://github.com/BUPT-GAMMA/OpenHGNN
# If you encounter a network error, try git clone from openi as following.
# git clone https://git.openi.org.cn/GAMMALab/OpenHGNN.git
cd OpenHGNN
pip install .

5. 安装 gdbi(可选):

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

在已有的评测上运行已有的基线模型 数据集

python main.py -m model_name -d dataset_name -t task_name -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 意味着你使用该模型在该数据集下最优的配置,如果你想要设定不同的超参数,请手动修改 配置文件。使用最佳配置会覆盖配置文件中的参数。

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

--use_database 从数据库加载数据集

---mini_batch_flag 使用mini_batch方式训练HGNN

---graphbolt 使用graphbolt框架的mini_batch训练流程

---use_distributed 使用分布式方式训练HGNN

示例:

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/{model_name}/

示例:

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

提示:需要先运行一次你想要可视化的模型,才能用以上命令可视化结果。

使用gdbi访问数据库中的标准图数据

以neo4j数据库和imdb数据集为例

LOAD CSV WITH HEADERS FROM "file:///data.csv" AS row
CREATE (:graphname_labelname {ID: row.ID, ... });
self.graph_address = [graph_address]
self.user_name = [user_name]
self.password = [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]
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:

候选模型

贡献者

OpenHGNN团队[北邮 GAMMA 实验室]、DGL 团队和鹏城实验室。

贡献者名单

引用OpenHGNN

欢迎在您的工作中用如下的方式引用OpenHGNN:

@inproceedings{han2022openhgnn,
  title={OpenHGNN: An Open Source Toolkit for Heterogeneous Graph Neural Network},
  author={Hui Han, Tianyu Zhao, Cheng Yang, Hongyi Zhang, Yaoqi Liu, Xiao Wang, Chuan Shi},
  booktitle={CIKM},
  year={2022}
}