Skip to main content

Temporal Graph Benchmark project repo

Project description

TGB logo

Temporal Graph Benchmark for Machine Learning on Temporal Graphs (NeurIPS 2023 Datasets and Benchmarks Track)

TGB 2.0: A Benchmark for Learning on Temporal Knowledge Graphs and Heterogeneous Graphs (NeurIPS 2024 Datasets and Benchmarks Track)

Overview of the Temporal Graph Benchmark (TGB) pipeline:

  • TGB includes large-scale and realistic datasets from 10 different domains with both dynamic link prediction and node property prediction tasks.
  • TGB automatically downloads datasets and processes them into numpy, PyTorch and PyG compatible TemporalData formats.
  • Novel TG models can be easily evaluated on TGB datasets via reproducible and realistic evaluation protocols.
  • TGB provides public and online leaderboards to track recent developments in temporal graph learning domain.
  • Now TGB supports temporal homogeneous graphs, temporal knowledge graphs and temporal heterogenenous graph datasets.

TGB dataloading and evaluation pipeline

To submit to TGB leaderboard, please fill in this google form

See all version differences and update notes here

Announcements

Excited to announce TGB 2.0, has been presented at NeurIPS 2024 Datasets and Benchmarks Track

See our camera ready version and arXiv version for details. Please install locally first. We welcome your feedback and suggestions.

Excited to announce TGX, a companion package for analyzing temporal graphs in WSDM 2024 Demo Track

TGX supports all TGB datasets and provides numerous temporal graph visualization plots and statistics out of the box. See our paper: Temporal Graph Analysis with TGX and TGX website.

Please update to version 2.2.0

version 2.2.0

Adding license for TGB software (for dataset license please check TGB website). Printing messages now will not automatically set to stdout, use TGB_VERBOSE=True in your shell to set the print to be verbose. Default option is to automatically download the datasets (rather than command line input as before).

version 2.1.0

Includes supplementary datasets tgbl-lastfm tgbl-enron tgbl-uci tgbl-subreddit for research purposes. For more details, see the release notes

version 2.0.0

Includes all new datasets from TGB 2.0 including temporal knowledge graphs and temporal heterogeneous graphs.

-->

Pip Install

You can install TGB via pip. Requires python >= 3.9

pip install py-tgb

Links and Datasets

The project website can be found here.

The API documentations can be found here.

all dataset download links can be found at info.py

TGB dataloader will also automatically download the dataset as well as the negative samples for the link property prediction datasets.

if website is unaccessible, please use this link instead.

Running Example Methods

  • For the dynamic link property prediction task, see the examples/linkproppred folder for example scripts to run TGN, DyRep and EdgeBank on TGB datasets.
  • For the dynamic node property prediction task, see the examples/nodeproppred folder for example scripts to run TGN, DyRep and EdgeBank on TGB datasets.
  • For all other baselines, please see the TGB_Baselines repo.

Acknowledgments

We thank the OGB team for their support throughout this project and sharing their website code for the construction of TGB website.

Software License

The code from this repo is licensed under the MIT License (see LICENSE)

Citation

If code or data from this repo is useful for your project, please consider citing our TGB and TGB 2.0 paper:

@article{huang2023temporal,
  title={Temporal graph benchmark for machine learning on temporal graphs},
  author={Huang, Shenyang and Poursafaei, Farimah and Danovitch, Jacob and Fey, Matthias and Hu, Weihua and Rossi, Emanuele and Leskovec, Jure and Bronstein, Michael and Rabusseau, Guillaume and Rabbany, Reihaneh},
  journal={Advances in Neural Information Processing Systems},
  year={2023}
}
@article{huang2024tgb2,
  title={TGB 2.0: A Benchmark for Learning on Temporal Knowledge Graphs and Heterogeneous Graphs},
  author={Gastinger, Julia and Huang, Shenyang and Galkin, Mikhail and Loghmani, Erfan and Parviz, Ali and Poursafaei, Farimah and Danovitch, Jacob and Rossi, Emanuele and Koutis, Ioannis and Stuckenschmidt, Heiner and      Rabbany, Reihaneh and Rabusseau, Guillaume},
  journal={Advances in Neural Information Processing Systems},
  year={2024}
}

Project details


Download files

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

Source Distribution

py_tgb-2.2.0.tar.gz (108.0 kB view details)

Uploaded Source

Built Distribution

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

py_tgb-2.2.0-py3-none-any.whl (154.4 kB view details)

Uploaded Python 3

File details

Details for the file py_tgb-2.2.0.tar.gz.

File metadata

  • Download URL: py_tgb-2.2.0.tar.gz
  • Upload date:
  • Size: 108.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.0 Linux/6.11.0-1018-azure

File hashes

Hashes for py_tgb-2.2.0.tar.gz
Algorithm Hash digest
SHA256 f8873a5621beba637db60d16ac12774aef81272b184ed3a310d7ea1952f17001
MD5 49146e68318f7048581e9efd4a513cf3
BLAKE2b-256 92ad9aa5963f598cd0e908c39f9471e63e08ae9913cab7463e97754e1edfb891

See more details on using hashes here.

File details

Details for the file py_tgb-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: py_tgb-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 154.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.0 Linux/6.11.0-1018-azure

File hashes

Hashes for py_tgb-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67b704a71606cc18cee7944b151da66b900b78026124a235bf410ac425cfd742
MD5 85b339af4efa86c28091c65f16abd0f4
BLAKE2b-256 78b287ff16174a8ffe660d19742a23f826142ae94fd47c66bb09ffc0e4e36ec2

See more details on using hashes here.

Supported by

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