Graphormer 是一个深度学习工具包，旨在帮助研究人员和开发者训练用于分子建模任务的自定义模型。它的目标是加速人工智能在分子科学领域的研究与应用，例如材料发现、药物研发等。项目官网。

Graphormer 的高级预训练版本仅在 Azure Quantum Elements 上提供。

招聘

目前招聘暂时冻结，将于近期重新开放，请持续关注。

我们正在各个层级招聘（包括全职研究员和实习生）！如果您对与我们一起从事分子科学领域的人工智能研究感兴趣，请将您的简历发送至 shuz@microsoft.com。

Graphormer v2.0 亮点

• 提供了在 Open Catalyst Challenge 中使用的模型、代码和脚本。
• 提供了 PCQM4M 和 PCQM4Mv2 数据集上的预训练模型，更多预训练模型即将发布。
• 支持 PyG、DGL、OGB 和 OCP 的接口及数据集。
• 支持 Fairseq 后端。
• 文档已上线！

最新动态：

2022年3月10日

1. 我们上传了一篇 技术报告，其中描述了在 PCQM4M 和 Open Catalyst Project 上的改进基准测试结果。

2021年12月22日

1. Graphormer v2.0 正式发布。欢迎体验！

2021年12月10日

1. Graphormer 荣获 Open Catalyst Challenge 冠军。相关技术演讲可通过此链接观看：视频链接。
2. NeurIPS 2021 的 幻灯片 可通过此链接查看：幻灯片链接。
3. Graphormer 新版本 即将发布，它将作为一个通用的分子建模工具包，包含 OC 数据集中的模型、完善的预训练模型库、灵活的数据接口以及更高的训练效率。

2021年9月30日

1. Graphormer 已被 NeurIPS 2021 接受。
2. 我们正在招聘！更多信息请联系 shuz[at]microsoft.com。

2021年8月3日

1. 代码和脚本正式发布。

2021年6月16日

1. Graphormer 在 Open Graph Benchmark 大规模挑战赛（KDD CUP 2021）的量子预测赛道中荣获 第一名 [比赛介绍] [比赛结果] [技术报告] [英文博客] [中文博客]

开始使用

我们的主要文档位于 https://graphormer.readthedocs.io/，该文档由本仓库生成，其中包含了入门指南、如何训练新模型以及如何通过新增模型类型和任务扩展 Graphormer 的说明。

接下来您可能想阅读：

• 示例，展示了常见任务的命令行用法。

系统要求与安装

使用 Conda 进行设置

bash install.sh

引用

如果您使用了本代码，请引用以下论文：

@article{shi2022benchmarking,
  title={Benchmarking Graphormer on Large-Scale Molecular Modeling Datasets},
  author={Yu Shi and Shuxin Zheng and Guolin Ke and Yifei Shen and Jiacheng You and Jiyan He and Shengjie Luo and Chang Liu and Di He and Tie-Yan Liu},
  journal={arXiv preprint arXiv:2203.04810},
  year={2022},
  url={https://arxiv.org/abs/2203.04810}
}

@inproceedings{
ying2021do,
title={Do Transformers Really Perform Badly for Graph Representation?},
author={Chengxuan Ying and Tianle Cai and Shengjie Luo and Shuxin Zheng and Guolin Ke and Di He and Yanming Shen and Tie-Yan Liu},
booktitle={Thirty-Fifth Conference on Neural Information Processing Systems},
year={2021},
url={https://openreview.net/forum?id=OeWooOxFwDa}
}

贡献

本项目欢迎各类贡献和建议。大多数贡献都需要您同意一份贡献者许可协议（CLA），以声明您有权并确实授予我们使用您贡献的权利。详情请访问 https://cla.opensource.microsoft.com。

当您提交拉取请求时，CLA 机器人会自动判断您是否需要提供 CLA，并相应地标记 PR（例如状态检查或评论）。您只需按照机器人提供的指示操作即可。对于所有使用我们 CLA 的仓库，您只需完成一次此流程。

本项目已采用 微软开源行为准则。如需更多信息，请参阅 行为准则常见问题解答，或如有任何其他疑问或意见，请联系 opencode@microsoft.com。

商标

本项目可能包含与项目、产品或服务相关的商标或标识。未经授权使用微软商标或标识须遵守并遵循 微软商标与品牌指南。在本项目的修改版本中使用微软商标或标识时，不得造成混淆或暗示微软的赞助关系。任何第三方商标或标识的使用均应遵守其各自的政策。

Graphormer 快速上手指南

Graphormer 是一个专为分子建模任务设计的深度学习包，旨在加速材料发现、药物研发等 AI for Science 领域的应用。它支持 PyG、DGL、OGB 和 OCP 等多种主流接口与数据集。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：推荐 Linux (Ubuntu/CentOS) 或 macOS。Windows 用户建议使用 WSL2。
• Python 版本：Python 3.7 或更高版本。
• 依赖管理：推荐使用 Conda 进行环境隔离和依赖安装。
• 硬件要求：训练模型建议使用 NVIDIA GPU，并安装对应的 CUDA 驱动。

注意：国内开发者若遇到网络问题，建议在配置 Conda 时使用清华或中科大镜像源加速包下载。

安装步骤

Graphormer 提供了便捷的脚本以自动处理依赖关系。推荐使用 Conda 进行安装：

1. 克隆仓库（如果尚未克隆）：

   git clone https://github.com/microsoft/Graphormer.git
   cd Graphormer
   

2. 运行安装脚本：

   bash install.sh
   

该脚本将自动创建 Conda 环境并安装所有必要的依赖项（包括 PyTorch、Fairseq 及相关图神经网络库）。

基本使用

安装完成后，您可以参考官方提供的示例脚本来运行常见的分子建模任务。

查看示例命令

项目根目录下的 examples 文件夹包含了针对常见任务的命令行用法示例。您可以进入该目录查看具体配置：

ls examples

运行训练任务

通常，使用 Graphormer 训练模型的命令结构如下（具体参数请参考 examples 中的配置文件）：

python train.py --data-path <path_to_data> --arch graphormer --task <task_name> ...

• 详细文档：更完整的训练指南、新模型扩展方法及 API 说明，请访问官方文档站点：https://graphormer.readthedocs.io/
• 预训练模型：部分高级预训练模型可通过 Azure Quantum Elements 获取，开源版本中已包含 PCQM4M 等数据集的预训练权重。

引用

如果您在研究中使用了 Graphormer 的代码或模型，请务必引用以下论文：

@article{shi2022benchmarking,
  title={Benchmarking Graphormer on Large-Scale Molecular Modeling Datasets},
  author={Yu Shi and Shuxin Zheng and Guolin Ke and Yifei Shen and Jiacheng You and Jiyan He and Shengjie Luo and Chang Liu and Di He and Tie-Yan Liu},
  journal={arXiv preprint arXiv:2203.04810},
  year={2022}
}