Assess how your model compares against state-of-the-art topological neural networks.
Overview β’ Get Started β’ Tutorials β’ Neural Networks β’ Liftings β’ Datasets β’ References
TopoBench
(TB) is a modular Python library designed to standardize benchmarking and accelerate research in Topological Deep Learning (TDL). In particular, TB allows to train and compare the performances of all sorts of Topological Neural Networks (TNNs) across the different topological domains, where by topological domain we refer to a graph, a simplicial complex, a cellular complex, or a hypergraph. For detailed information, please refer to the TopoBench: A Framework for Benchmarking Topological Deep Learning
paper.
The main pipeline trains and evaluates a wide range of state-of-the-art TNNs and Graph Neural Networks (GNNs) (see βοΈ Neural Networks) on numerous and varied datasets and benchmark tasks (see π Datasets ). Additionally, the library offers the ability to transform, i.e. lift, each dataset from one topological domain to another (see π Liftings), enabling for the first time an exhaustive inter-domain comparison of TNNs.
If you do not have conda on your machine, please follow their guide to install it.
First, clone the TopoBench
repository and set up a conda environment tb
with python 3.11.3.
git clone [email protected]:geometric-intelligence/topobench.git
cd TopoBench
conda create -n tb python=3.11.3
Next, check the CUDA version of your machine:
/usr/local/cuda/bin/nvcc --version
and ensure that it matches the CUDA version specified in the env_setup.sh
file (CUDA=cu121
by default). If it does not match, update env_setup.sh
accordingly by changing both the CUDA
and TORCH
environment variables to compatible values as specified on this website.
Next, set up the environment with the following command.
source env_setup.sh
This command installs the TopoBench
library and its dependencies.
Next, train the neural networks by running the following command:
python -m topobench
Thanks to hydra
implementation, one can easily override the default experiment configuration through the command line. For instance, the model and dataset can be selected as:
python -m topobench model=cell/cwn dataset=graph/MUTAG
Remark: By default, our pipeline identifies the source and destination topological domains, and applies a default lifting between them if required.
The same CLI override mechanism also applies when modifying more finer configurations within a CONFIG GROUP
. Please, refer to the official hydra
documentation for further details.
To reproduce Table 1 from the TopoBench: A Framework for Benchmarking Topological Deep Learning
paper, please run the following command:
bash scripts/reproduce.sh
Remark: We have additionally provided a public W&B (Weights & Biases) project with logs for the corresponding runs (updated on June 11, 2024).
Explore our tutorials for further details on how to add new datasets, transforms/liftings, and benchmark tasks.
We list the neural networks trained and evaluated by TopoBench
, organized by the topological domain over which they operate: graph, simplicial complex, cellular complex or hypergraph. Many of these neural networks were originally implemented in TopoModelX
.
Model | Reference |
---|---|
CAN | Cell Attention Network |
CCCN | Inspired by A learning algorithm for computational connected cellular network, implementation adapted from Generalized Simplicial Attention Neural Networks |
CXN | Cell Complex Neural Networks |
CWN | Weisfeiler and Lehman Go Cellular: CW Networks |
Model | Reference |
---|---|
GCCN | TopoTune: A Framework for Generalized Combinatorial Complex Neural Networks |
Remark: TopoBench includes TopoTune, a comprehensive framework for easily designing new, general TDL models on any domain using any (graph) neural network as a backbone. Please check out the extended TopoTune wiki page for further details on how to leverage this framework to define and train customized topological neural network architectures.
We list the liftings used in TopoBench
to transform datasets. Here, a lifting refers to a function that transforms a dataset defined on a topological domain (e.g., on a graph) into the same dataset but supported on a different topological domain (e.g., on a simplicial complex).
The structural lifting is responsible for the transformation of the underlying relationships or elements of the data. For instance, it might determine how nodes and edges in a graph are mapped into triangles and tetrahedra in a simplicial complex. This structural transformation can be further categorized into connectivity-based, where the mapping relies solely on the existing connections within the data, and feature-based, where the data's inherent properties or features guide the new structure.
We enumerate below the structural liftings currently implemented in TopoBench
; please check out the provided description links for further details.
Remark:: Most of these liftings are adaptations of winner submissions of the ICML TDL Challenge 2024 (paper | repo); see the Structural Liftings wiki for a complete list of compatible liftings.
Name | Type | Description |
---|---|---|
DnD Lifting | Feature-based | Wiki page |
Random Latent Clique Lifting | Connectivity-based | Wiki page |
Line Lifting | Connectivity-based | Wiki page |
Neighbourhood Complex Lifting | Connectivity-based | Wiki page |
Graph Induced Lifting | Connectivity-based | Wiki page |
Eccentricity Lifting | Connectivity-based | Wiki page |
FeatureβBased Rips Complex | Both connectivity and feature-based | Wiki page |
Clique Lifting | Connectivity-based | Wiki page |
K-hop Lifting | Connectivity-based | Wiki page |
Name | Type | Description |
---|---|---|
Discrete Configuration Complex | Connectivity-based | Wiki page |
Cycle Lifting | Connectivity-based | Wiki page |
Name | Type | Description |
---|---|---|
Expander Hypergraph Lifting | Connectivity-based | Wiki page |
Kernel Lifting | Both connectivity and feature-based | Wiki page |
Mapper Lifting | Connectivity-based | Wiki page |
FormanβRicci Curvature Coarse Geometry Lifting | Connectivity-based | Wiki page |
KNN Lifting | Feature-based | Wiki page |
K-hop Lifting | Connectivity-based | Wiki page |
Name | Type | Description |
---|---|---|
Delaunay Lifting | Feature-based | Wiki page |
Random Flag Complex | Feature-based | Wiki page |
Name | Type | Description |
---|---|---|
Mixture of Gaussians MST lifting | Feature-based | Wiki page |
PointNet Lifting | Feature-based | Wiki page |
Voronoi Lifting | Feature-based | Wiki page |
Name | Type | Description |
---|---|---|
Coface Lifting | Connectivity-based | Wiki page |
Name | Type | Description |
---|---|---|
Universal Strict Lifting | Connectivity-based | Wiki page |
Feature liftings address the transfer of data attributes or features during mapping, ensuring that the properties associated with the data elements are consistently preserved in the new representation.
Name | Description | Supported Domains |
---|---|---|
ProjectionSum | Projects r-cell features of a graph to r+1-cell structures utilizing incidence matrices (B_{r}). | All |
ConcatenationLifting | Concatenate r-cell features to obtain r+1-cell features. | Simplicial |
Specially useful in pre-processing steps, these are the general data manipulations currently implemented in TopoBench
:
Transform | Description |
---|---|
OneHotDegreeFeatures | Adds the node degree as one hot encodings to the node features. |
NodeFeaturesToFloat | Converts the node features of the input graph to float. |
NodeDegrees | Calculates the node degrees of the input graph. |
NodeDegrees | Keeps only the selected fields of the input data. |
KeepOnlyConnectedComponent | Keep only the largest connected components of the input graph. |
InfereRadiusConnectivity | Generates the radius connectivity of the input point cloud. |
InfereKNNConnectivity | Generates the k-nearest neighbor connectivity of the input point cloud. |
IdentityTransform | An identity transform that does nothing to the input data. |
EqualGausFeatures | Generates equal Gaussian features for all nodes. |
CalculateSimplicialCurvature | Calculates the simplicial curvature of the input graph. |
Dataset | Task | Description | Reference |
---|---|---|---|
Cora | Classification | Cocitation dataset. | Source |
Citeseer | Classification | Cocitation dataset. | Source |
Pubmed | Classification | Cocitation dataset. | Source |
MUTAG | Classification | Graph-level classification. | Source |
PROTEINS | Classification | Graph-level classification. | Source |
NCI1 | Classification | Graph-level classification. | Source |
NCI109 | Classification | Graph-level classification. | Source |
IMDB-BIN | Classification | Graph-level classification. | Source |
IMDB-MUL | Classification | Graph-level classification. | Source |
Classification | Graph-level classification. | Source | |
Amazon | Classification | Heterophilic dataset. | Source |
Minesweeper | Classification | Heterophilic dataset. | Source |
Empire | Classification | Heterophilic dataset. | Source |
Tolokers | Classification | Heterophilic dataset. | Source |
US-county-demos | Regression | In turn each node attribute is used as the target label. | Source |
ZINC | Regression | Graph-level regression. | Source |
Dataset | Task | Description | Reference |
---|---|---|---|
Mantra | Classification, Multi-label Classification | Predict topological attributes of manifold triangulations | Source |
Dataset | Task | Description | Reference |
---|---|---|---|
Cora-Cocitation | Classification | Cocitation dataset. | Source |
Citeseer-Cocitation | Classification | Cocitation dataset. | Source |
PubMed-Cocitation | Classification | Cocitation dataset. | Source |
Cora-Coauthorship | Classification | Cocitation dataset. | Source |
DBLP-Coauthorship | Classification | Cocitation dataset. | Source |
To learn more about TopoBench
, we invite you to read the paper:
@article{telyatnikov2024topobench,
title={TopoBench: A Framework for Benchmarking Topological Deep Learning},
author={Lev Telyatnikov and Guillermo Bernardez and Marco Montagna and Pavlo Vasylenko and Ghada Zamzmi and Mustafa Hajij and Michael T Schaub and Nina Miolane and Simone Scardapane and Theodore Papamarkou},
year={2024},
eprint={2406.06642},
archivePrefix={arXiv},
primaryClass={cs.LG},
url={https://arxiv.org/abs/2406.06642},
}
If you find TopoBench
useful, we would appreciate if you cite us!
Hierarchy of configuration files
βββ configs <- Hydra configs
β βββ callbacks <- Callbacks configs
β βββ dataset <- Dataset configs
β β βββ graph <- Graph dataset configs
β β βββ hypergraph <- Hypergraph dataset configs
β β βββ simplicial <- Simplicial dataset configs
β βββ debug <- Debugging configs
β βββ evaluator <- Evaluator configs
β βββ experiment <- Experiment configs
β βββ extras <- Extra utilities configs
β βββ hparams_search <- Hyperparameter search configs
β βββ hydra <- Hydra configs
β βββ local <- Local configs
β βββ logger <- Logger configs
β βββ loss <- Loss function configs
β βββ model <- Model configs
β β βββ cell <- Cell model configs
β β βββ graph <- Graph model configs
β β βββ hypergraph <- Hypergraph model configs
β β βββ simplicial <- Simplicial model configs
β βββ optimizer <- Optimizer configs
β βββ paths <- Project paths configs
β βββ scheduler <- Scheduler configs
β βββ trainer <- Trainer configs
β βββ transforms <- Data transformation configs
β β βββ data_manipulations <- Data manipulation transforms
β β βββ dataset_defaults <- Default dataset transforms
β β βββ feature_liftings <- Feature lifting transforms
β β βββ liftings <- Lifting transforms
β β βββ graph2cell <- Graph to cell lifting transforms
β β βββ graph2hypergraph <- Graph to hypergraph lifting transforms
β β βββ graph2simplicial <- Graph to simplicial lifting transforms
β β βββ graph2cell_default.yaml <- Default graph to cell lifting config
β β βββ graph2hypergraph_default.yaml <- Default graph to hypergraph lifting config
β β βββ graph2simplicial_default.yaml <- Default graph to simplicial lifting config
β β βββ no_lifting.yaml <- No lifting config
β β βββ custom_example.yaml <- Custom example transform config
β β βββ no_transform.yaml <- No transform config
β βββ wandb_sweep <- Weights & Biases sweep configs
β β
β βββ __init__.py <- Init file for configs module
β βββ run.yaml <- Main config for training
More information regarding Topological Deep Learning
Topological Graph Signal Compression
Architectures of Topological Deep Learning: A Survey on Topological Neural Networks
TopoX: a suite of Python packages for machine learning on topological domains