Skip to content

API reference

Five modules, in the order they compose. Each page renders the module's own docstring and then every public symbol, so a citation or a caveat sits beside the implementation it describes.

  • Running a benchmark

    graphnetz.benchmark · the runner, BenchmarkReport, the task catalogue and the model registry
    graphnetz.training · one trainer per task family

  • Data

    graphnetz.datasets · 62 loaders across 10 categories
    Netz · any network from the Netzschleuder catalogue
    validate_loaders · does the catalogue actually load?

  • Models

    graphnetz.models · GCN, GAT, GIN, GraphSAGE, GraphTransformer, DGI
    _adapters · the wrappers that reach every task type

  • Output

    graphnetz.plotting · the brand and figure palettes, figure helpers, plot builders

Top-level convenience imports

Importable directly from graphnetz:

Models

GCN · GAT · GIN · GraphSAGE · GraphTransformer · DGI — see Models.

Datasets

CATEGORIES · Netz · download_all_networks_netz · list_datasets · validate_loaders — see Datasets.

Benchmark

BENCHMARK_TASKS · BenchmarkReport · ModelSpec · SearchSpace · Task · iter_benchmark_tasks · plot_benchmark · register_model · register_task · run_benchmark · task_from_dataset · unregister_task — see Benchmark.

Training utilities

train_node_classification · train_graph_classification · train_graph_regression · train_link_prediction · train_dgi · train_node_degree_regression · train_relational_link_prediction — see Training.

Plotting

figure · panel_label · plot_grouped_bars · plot_history · save_figure · set_plot_style — see Plotting.

Citations

Every model carries its reference in its own docstring, so the paper sits beside the code:

help(graphnetz.GIN)
model paper
GCN Kipf & Welling, ICLR 2017 · arXiv:1609.02907
GAT Veličković et al., ICLR 2018 · arXiv:1710.10903
GIN Xu et al., ICLR 2019 · arXiv:1810.00826
GraphSAGE Hamilton, Ying & Leskovec, NeurIPS 2017 · arXiv:1706.02216
GraphTransformer Shi et al., IJCAI 2021 · arXiv:2009.03509
DGI Veličković et al., ICLR 2019 · arXiv:1809.10341

The statistical procedures carry theirs too:

procedure reference
Friedman + Nemenyi critical difference Demšar, JMLR 7:1-30, 2006
Wilcoxon signed-rank for classifier comparison Benavoli et al., JMLR 17(5):1-36, 2016
Holm step-down correction Holm, Scand. J. Statist. 6(2):65-70, 1979