Skip to content

Welcome to Temporal Graph Benchmark

TGB logo

Pip Install

You can install TGB via pip

pip install py-tgb

The project website can be found here.

The API documentations can be found here.

all dataset download links can be found at

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

Install dependency

Our implementation works with python >= 3.9 and can be installed as follows

  1. set up virtual environment (conda should work as well)

    python -m venv ~/tgb_env/
    source ~/tgb_env/bin/activate

  2. install external packages

    pip install pandas==1.5.3
    pip install matplotlib==3.7.1
    pip install clint==0.5.1

install Pytorch and PyG dependencies (needed to run the examples)

pip install torch==2.0.0 --index-url
pip install torch_geometric==2.3.0
pip install pyg_lib torch_scatter torch_sparse torch_cluster torch_spline_conv -f

  1. install local dependencies under root directory /TGB
    pip install -e .

Instruction for tracking new documentation and running mkdocs locally

  1. first run the mkdocs server locally in your terminal

    mkdocs serve

  2. go to the local hosted web address similar to

    [14:18:13] Browser connected:

Example: to track documentation of a new file in tgb/edgeregression/

  1. create docs/api/ and add the following

    # `tgb.edgeregression`
    ::: tgb.edgeregression.hi

  2. edit mkdocs.yml

      - Overview:
      - About:
      - API:
        other *.md files 
        - tgb.edgeregression: api/

Creating new branch

git fetch origin

git checkout -b test origin/test

dependencies for mkdocs (documentation)

pip install mkdocs
pip install mkdocs-material
pip install mkdocstrings-python
pip install mkdocs-jupyter
pip install notebook

full dependency list

Our implementation works with python >= 3.9 and has the following dependencies

pytorch == 2.0.0
torch-geometric == 2.3.0