Skip to main content

RelBench

Website: STAR Project Data: Hugging Face PyPI Tests arXiv: RelBench arXiv: RelBench v2 License: MIT

News · Get Started · Tutorials · Leaderboard · BYOD · Citations

News

RelBench 3 loads every dataset family below from the Hugging Face Hub with one call — relbench.load_dataset("<org>/<repo>/<name>") — the core databases (stanford-star/relbench-v1, stanford-star/relbench-v2-extra), CTU/ReDeLEx (stanford-star/redelex), 4DBInfer (stanford-star/dbinfer) and TGB (stanford-star/tgb); the [ctu] extra is gone. MIMIC-IV requires PhysioNet credentials and is not hosted. TGB and 4DBInfer tasks that use their own scoring protocols load as data only (see MIGRATION.md).

Get Started

pip install relbench             # data + task loading
pip install "relbench[example]"  # + PyTorch Geometric & PyTorch Frame, for the GNN examples
pip install pyg-lib -f https://data.pyg.org/whl/torch-2.9.0+cpu.html  # neighbor sampling; use the index matching your torch/CUDA build

Load a dataset and a task — both come straight from the Hub, with no per-dataset code:

import relbench

dataset = relbench.load_dataset("rel-f1")   # or a HuggingFace 'org/repo[/subdir]', or a local path
db = dataset.get_db()                  # rows after test_timestamp are hidden

task = dataset.load_task("driver-position")   # dataset.get_task_names() lists them
train_table = task.get_table("train")  # train / val / test label tables
test_table  = task.get_table("test")   # the target column is hidden on test

# ... train any model on db + train_table, predict on the test entities ...
metrics = task.evaluate(test_pred)     # standard metric for the task type

dataset.val_timestamp / dataset.test_timestamp give the temporal split points. RelBench is framework-agnostic — bring any modeling stack. For a reference Graph Neural Network on PyTorch Geometric + PyTorch Frame, see relbench.modeling and the runnable scripts in examples/.

Tutorials

Open these directly in Google Colab — no setup required:

Tutorial What it covers
Quickstart Load a dataset/task, explore the schema, run a baseline Open In Colab
Training a GNN A GNN baseline for an entity task (PyG + PyTorch Frame) Open In Colab

Leaderboard

The RelBench leaderboard ranks methods by their test-set performance, averaged over a fixed task set. There are three independent boards — classification (12 tasks), regression (9), and recommendation (10); the task lists are in relbench.submit.LEADERBOARD_TASKS. You can submit to any of them; each requires predictions for all of its tasks.

To submit:

  1. Write one prediction CSV per task, named <dataset>__<task>.csv, into a directory:

    relbench.submit.write_prediction_table(task, test_pred, "preds/rel-f1__driver-position.csv")
    
  2. Validate and package the directory — this scores every CSV against the test tables, prints a verdict per leaderboard, and writes clean submission zip file(s):

    python -m relbench.submit preds/
    
  3. Open a submission issue on this repository: fill in the short form and upload the zip file(s) into it.

The submission is validated automatically and the report is posted on the issue; once a maintainer approves, your entry appears on the leaderboard.

BYOD (Bring Your Own Data)

You can easily express your own databases and tasks in the RelBench format. A dataset is a self-describing folder — a manifest.yaml (tables, keys, the foreign-key graph, the time splits), one plain parquet per table, and a tasks/ subdirectory — that you publish to the Hugging Face Hub. RelBench loads it straight from its org/repo[/subdir] address; there is no central registry to register with.

byod/README.md is the full walkthrough, and the published stanford-star/relbench-v1/rel-f1 is a complete worked example. For how RelBench's own databases were built, cleaned, and verified from their original sources, see provenance/.

If you upload your data in RelBench format to Hugging Face, please let us know by opening an issue / making a PR so we can list it here!

Citations

If you use RelBench, please cite the benchmark papers:

@inproceedings{relbench,
  title={RelBench: A Benchmark for Deep Learning on Relational Databases},
  author={Robinson, Joshua and Ranjan, Rishabh and Hu, Weihua and Huang, Kexin and Han, Jiaqi and Dobles, Alejandro and Fey, Matthias and Lenssen, Jan Eric and Yuan, Yiwen and Zhang, Zecheng and He, Xinwei and Leskovec, Jure},
  booktitle={Advances in Neural Information Processing Systems},
  year={2024}
}

@misc{relbenchv2,
  title={RelBench v2: A Large-Scale Benchmark and Repository for Relational Data},
  author={Gu, Justin and Ranjan, Rishabh and Kanatsoulis, Charilaos and Tang, Haiming and Jurkovic, Martin and Hudovernik, Valter and Znidar, Mark and Chaturvedi, Pranshu and Shroff, Parth and Li, Fengyu and Leskovec, Jure},
  year={2026},
  eprint={2602.12606},
  archivePrefix={arXiv},
  primaryClass={cs.LG},
  url={https://arxiv.org/abs/2602.12606}
}

Datasets sourced from external repositories (CTU/ReDeLEx, 4DBInfer, TGB) carry their own citations on their Hugging Face dataset cards.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

relbench-3.0.0.tar.gz (58.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

relbench-3.0.0-py3-none-any.whl (64.8 kB view details)

Uploaded Python 3

File details

Details for the file relbench-3.0.0.tar.gz.

File metadata

  • Download URL: relbench-3.0.0.tar.gz
  • Upload date:
  • Size: 58.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for relbench-3.0.0.tar.gz
Algorithm Hash digest
SHA256 efe51f11262788ef648e295f26094485b4c277384c49bba7ca15b83d601a5f8a
MD5 eb0bd80402dd9a727ee593ee132db6da
BLAKE2b-256 e2bb515b9d7592f9ec62f019974b4733fed5e9a9b764dd88762c9dd3931a8977

See more details on using hashes here.

File details

Details for the file relbench-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: relbench-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 64.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for relbench-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 77fe60c28ac24be2f439f14586addd2f9791f7533984c61e34bfde44ae2088c9
MD5 74955ec24cba4cceb277f073a9d650f5
BLAKE2b-256 b7c240cee8ecbdf8500bea0015cfca17c783b7b75afa4937dd1ff6d8669c080f

See more details on using hashes here.

Release history Release notifications | RSS feed

3.0.1

2 files

This release

3.0.0 This release

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.1.0

2 files

1.0.0

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page