---

概述

开放图基准（OGB）是一套用于图机器学习的基准数据集、数据加载器和评估工具。这些数据集涵盖了多种图机器学习任务和现实世界应用。 OGB 的数据加载器与流行的图深度学习框架完全兼容，包括 PyTorch Geometric 和 Deep Graph Library (DGL)。它们提供自动下载数据集、标准化的数据划分以及统一的性能评估功能。

OGB 的目标是提供覆盖重要图机器学习任务、具有不同规模并涉及丰富领域的图数据集。

图机器学习任务： 我们涵盖了三种基本的图机器学习任务：节点级预测、边级预测和图级预测。

多样化的规模： 小规模图数据集可以在单个 GPU 上处理，而中大规模图可能需要使用多个 GPU 或巧妙的采样/分区技术。

丰富的领域： 图数据集来自不同的领域，从科学领域到社交网络和信息网络，还包括异构知识图谱。

OGB 是一项持续进行的工作，我们计划在未来进一步扩大其覆盖范围。

安装

您可以使用 Python 的包管理器 pip 来安装 OGB。 如果您之前已经安装过 ogb，请确保将其更新至 1.3.6 版本。 发布说明请参见 此处。

需求

• Python>=3.6
• PyTorch>=1.6
• DGL>=0.5.0 或 torch-geometric>=2.0.2
• Numpy>=1.16.0
• pandas>=0.24.0
• urllib3>=1.24.0
• scikit-learn>=0.20.0
• outdated>=0.2.0

使用 pip 安装

推荐使用 Python 的包管理器 pip 来安装 OGB：

pip install ogb

python -c "import ogb; print(ogb.__version__)"
# 这应该打印出 "1.3.6"。否则，请通过以下命令更新版本：
pip install -U ogb

从源代码安装

您也可以从源代码安装 OGB。如果您希望为 OGB 做出贡献，建议采用此方法。

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

软件包使用

我们重点介绍 OGB 的两个关键特性，即 (1) 易于使用的数据加载器，以及 (2) 标准化的评估工具。

(1) 数据加载器

我们提供了易于使用的 PyTorch Geometric 和 DGL 数据加载器。它们负责数据集的下载以及标准化的数据划分。 以下以 PyTorch Geometric 为例，只需几行代码即可完成数据集的准备和划分！当然，DGL 也同样方便！

from ogb.graphproppred import PygGraphPropPredDataset
from torch_geometric.loader import DataLoader

# 下载并处理数据至 './dataset/ogbg_molhiv/'
dataset = PygGraphPropPredDataset(name = 'ogbg-molhiv')

split_idx = dataset.get_idx_split() 
train_loader = DataLoader(dataset[split_idx['train']], batch_size=32, shuffle=True)
valid_loader = DataLoader(dataset[split_idx['valid']], batch_size=32, shuffle=False)
test_loader = DataLoader(dataset[split_idx['test']], batch_size=32, shuffle=False)

(2) 评估工具

我们还提供了标准化的评估工具，便于对不同方法进行评估和比较。评估工具接受一个 input_dict（其格式由 evaluator.expected_input_format 指定）作为输入，并返回一个包含针对特定数据集的性能指标的字典。 这种标准化的评估协议使研究人员能够可靠地比较各自的方法。

from ogb.graphproppred import Evaluator

evaluator = Evaluator(name = 'ogbg-molhiv')
# 您可以通过以下方式了解评估工具的输入和输出格式规范：
# print(evaluator.expected_input_format) 
# print(evaluator.expected_output_format) 
input_dict = {'y_true': y_true, 'y_pred': y_pred}
result_dict = evaluator.eval(input_dict) # 例如，{'rocauc': 0.7321}

引用 OGB / OGB-LSC

如果您在工作中使用了 OGB 或 OGB-LSC 的数据集，请引用我们的论文（BibTeX 如下）。

@article{hu2020ogb,
  title={Open Graph Benchmark: Datasets for Machine Learning on Graphs},
  author={Hu, Weihua and Fey, Matthias and Zitnik, Marinka and Dong, Yuxiao and Ren, Hongyu and Liu, Bowen and Catasta, Michele and Leskovec, Jure},
  journal={arXiv preprint arXiv:2005.00687},
  year={2020}
}

@article{hu2021ogblsc,
  title={OGB-LSC: A Large-Scale Challenge for Machine Learning on Graphs},
  author={Hu, Weihua and Fey, Matthias and Ren, Hongyu and Nakata, Maho and Dong, Yuxiao and Leskovec, Jure},
  journal={arXiv preprint arXiv:2103.09430},
  year={2021}
}

OGB 快速上手指南

Open Graph Benchmark (OGB) 是一套用于图机器学习的基准数据集、数据加载器和评估器集合。它涵盖了节点、链接和图级别的预测任务，并完美兼容 PyTorch Geometric (PyG) 和 Deep Graph Library (DGL) 框架，提供自动下载、标准化划分及统一性能评估。

环境准备

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

• 操作系统: Linux, macOS, Windows
• Python: >= 3.6
• 深度学习框架:
  • PyTorch >= 1.6
  • 以及以下任一图神经网络库：
    • DGL >= 0.5.0
    • 或 torch-geometric >= 2.0.2
• 其他依赖:
  • Numpy >= 1.16.0
  • pandas >= 0.24.0
  • scikit-learn >= 0.20.0
  • urllib3 >= 1.24.0
  • outdated >= 0.2.0

提示：国内用户建议使用清华源或阿里源加速 Python 包的安装。

安装步骤

推荐使用 pip 进行安装。如果您之前安装过 OGB，请务必更新至最新版本 (1.3.6)。

1. 使用 pip 安装（推荐）

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

安装完成后，验证版本是否正确：

python -c "import ogb; print(ogb.__version__)"
# 应输出 "1.3.6"。如果不是，请运行以下命令升级：
# pip install -U ogb

2. 从源码安装（可选）

如果您需要贡献代码或使用最新开发版，可从 GitHub 克隆源码安装：

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

基本使用

OGB 的核心功能包括易用的数据加载器和标准化的评估器。以下以 PyTorch Geometric 为例，展示如何加载 ogbg-molhiv 数据集并进行评估。

1. 数据加载与划分

OGB 会自动处理数据集的下载、预处理以及训练/验证/测试集的标准化划分。

from ogb.graphproppred import PygGraphPropPredDataset
from torch_geometric.loader import DataLoader

# 自动下载并处理数据到 './dataset/ogbg_molhiv/'
dataset = PygGraphPropPredDataset(name='ogbg-molhiv')

# 获取标准化的数据划分索引
split_idx = dataset.get_idx_split() 

# 创建数据加载器
train_loader = DataLoader(dataset[split_idx['train']], batch_size=32, shuffle=True)
valid_loader = DataLoader(dataset[split_idx['valid']], batch_size=32, shuffle=False)
test_loader = DataLoader(dataset[split_idx['test']], batch_size=32, shuffle=False)

2. 模型评估

使用 OGB 提供的标准化评估器，只需传入预测结果即可得到符合该数据集标准的性能指标（如 ROC-AUC）。

from ogb.graphproppred import Evaluator

# 初始化评估器
evaluator = Evaluator(name='ogbg-molhiv')

# 查看输入/输出格式规范（可选）
# print(evaluator.expected_input_format) 
# print(evaluator.expected_output_format) 

# 准备数据：y_true 为真实标签，y_pred 为模型预测值
input_dict = {'y_true': y_true, 'y_pred': y_pred}

# 执行评估，返回包含指标字典（例如 {'rocauc': 0.7321}）
result_dict = evaluator.eval(input_dict)