主页 | 论文 | 文档 | 讨论论坛 | 数据集 | 中文

CogDL 是一个图深度学习工具包，旨在帮助研究人员和开发者轻松训练和比较节点分类、图分类等图领域中的基准或自定义模型。

我们总结了 CogDL 的主要贡献如下：

• 高效性：CogDL 使用高度优化的算子来加速 GNN 模型的训练并节省 GPU 内存。
• 易用性：CogDL 提供简单易用的 API，支持使用给定的模型和数据集进行实验，并结合超参数搜索功能。
• 可扩展性：CogDL 的设计使得基于其框架将 GNN 模型应用于新场景变得十分便捷。

❗ 新闻

• CogDL 论文 已被 WWW 2023 接收。欢迎在 WWW 2023 上与我们交流！同时，我们发布了全新的 v0.6 版本，新增了多个图自监督学习示例，包括 GraphMAE、GraphMAE2 和 BGRL。

• CogDL 团队提供了一门免费的 GNN 课程，详情请见 此链接。此外，我们还为中文用户提供了一个 讨论论坛。

• 新版 v0.5.3 支持通过设置 \textit{fp16=True} 进行混合精度训练，并提供了由 Jittor 编写的基础 示例。该版本还更新了文档中的教程，修复了一些数据集的下载链接，并解决了算子中潜在的 bug。

入门指南

要求与安装

• Python 版本 ≥ 3.7
• PyTorch 版本 ≥ 1.7.1

请按照此处的说明安装 PyTorch（https://github.com/pytorch/pytorch#installation）。

安装好 PyTorch 后，可以使用 pip 安装 CogDL：

pip install cogdl

也可以通过源码安装：

pip install git+https://github.com/thudm/cogdl.git

或者克隆仓库并执行以下命令进行安装：

git clone git@github.com:THUDM/cogdl.git
cd cogdl
pip install -e .

使用方法

API 使用

您可以通过 CogDL 的 API 运行各种实验，尤其是 experiment。您还可以使用自己的数据集和模型进行实验。 快速入门示例可在 quick_start.py 中找到。更多示例请参阅 examples/。

from cogdl import experiment

# 基本用法
experiment(dataset="cora", model="gcn")

# 设置其他超参数
experiment(dataset="cora", model="gcn", hidden_size=32, epochs=200)

# 在不同随机种子下运行多个模型
experiment(dataset="cora", model=["gcn", "gat"], seed=[1, 2])

# 自动机器学习用法
def search_space(trial):
    return {
        "lr": trial.suggest_categorical("lr", [1e-3, 5e-3, 1e-2]),
        "hidden_size": trial.suggest_categorical("hidden_size", [32, 64, 128]),
        "dropout": trial.suggest_uniform("dropout", 0.5, 0.8),
    }

experiment(dataset="cora", model="gcn", seed=[1, 2], search_space=search_space)

命令行使用方法

你也可以使用 python scripts/train.py --dataset example_dataset --model example_model 来在 example_data 上运行 example_model。

• --dataset：要运行的数据集名称，可以是多个数据集的列表，用空格分隔，例如 cora citeseer。支持的数据集包括： 'cora', 'citeseer', 'pumbed', 'ppi', 'wikipedia', 'blogcatalog', 'flickr'。更多数据集可以在 cogdl/datasets 中找到。
• --model：要运行的模型名称，可以是多个模型的列表，例如 gcn gat。支持的模型包括： 'gcn', 'gat', 'graphsage', 'deepwalk', 'node2vec', 'hope', 'grarep', 'netmf', 'netsmf', 'prone'。更多模型可以在 cogdl/models 中找到。

例如，如果你想在 Cora 数据集上运行 GCN 和 GAT 模型，并使用 5 个不同的随机种子：

python scripts/train.py --dataset cora --model gcn gat --seed 0 1 2 3 4

预期输出：

如果你在上述步骤中遇到任何困难，请随时提交问题。我们将在 24 小时内回复你。

❗ 常见问题解答

$ python scripts/train.py --dataset cora --model gcn gat --hidden-size 64 --devices 0 1 --seed 0 1 2 3 4

CogDL 团队

CogDL 由 清华大学、浙江大学、达摩院和智谱AI 共同开发和维护。

核心开发团队的联系方式为 cogdlteam@gmail.com。

引用 CogDL

如果你的研究中使用了我们的代码或结果，请引用我们的论文：

@inproceedings{cen2023cogdl,
    title={CogDL: A Comprehensive Library for Graph Deep Learning},
    author={Yukuo Cen and Zhenyu Hou and Yan Wang and Qibin Chen and Yizhen Luo and Zhongming Yu and Hengrui Zhang and Xingcheng Yao and Aohan Zeng and Shiguang Guo and Yuxiao Dong and Yang Yang and Peng Zhang and Guohao Dai and Yu Wang and Chang Zhou and Hongxia Yang and Jie Tang},
    booktitle={Proceedings of the ACM Web Conference 2023 (WWW'23)},
    year={2023}
}

CogDL 快速上手指南

环境准备

• 系统要求
  Python 3.7 或更高版本
  PyTorch 1.7.1 或更高版本（需与 CUDA 版本匹配）

• 前置依赖
  安装 PyTorch 可参考官方文档：https://github.com/pytorch/pytorch#installation
  建议使用国内镜像加速安装，例如：

  pip install torch torchvision torchaudio --index-url https://pypi.tuna.tsinghua.edu.cn/simple
  

安装步骤

方法一：通过 pip 安装（推荐）

pip install cogdl -i https://pypi.tuna.tsinghua.edu.cn/simple

方法二：从源码安装

git clone git@github.com:THUDM/cogdl.git
cd cogdl
pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

方式一：Python API 调用

from cogdl import experiment

# 最简示例：在 Cora 数据集上训练 GCN 模型
experiment(dataset="cora", model="gcn")

方式二：命令行运行

python scripts/train.py --dataset cora --model gcn --seed 0 1 2 3 4

参数说明

• --dataset: 指定数据集（如 cora、citeseer 等）
• --model: 指定模型（如 gcn、gat 等）
• --seed: 设置随机种子列表（用于多次实验）

输出示例

| Variant      | test_acc       | val_acc        |
|--------------|----------------|----------------|
| ('cora', 'gcn') | 0.8050±0.0047  | 0.7940±0.0063  |