Documentation | Case Study | Installation | Data Structures | External Resources | Paper
PyTorch Geometric Signed Directed is a signed and directed extension library for PyTorch Geometric. It follows the package structure in PyTorch Geometric Temporal.
The library consists of various signed and directed geometric deep learning, embedding, and clustering methods from a variety of published research papers and selected preprints.
We also provide detailed examples in the examples folder.
Citing
If you find PyTorch Geometric Signed Directed useful in your research, please consider adding the following citation:
@article{he2022pytorch,
title={{PyTorch Geometric Signed Directed: A Survey and Software on Graph Neural Networks for Signed and Directed Graphs}},
author={He, Yixuan and Zhang, Xitong and Huang, Junjie and Cucuringu, Mihai and Reinert, Gesine},
journal={arXiv preprint arXiv:2202.10793},
year={2022}
}Methods Included
In detail, the following signed or directed graph neural networks, as well as related methods designed for signed or directed netwroks, were implemented.
Signed Network Models and Layers
-
SSSNET_node_clustering from He et al.: SSSNET: Semi-Supervised Signed Network Clustering (SDM 2022)
-
SDGNN from Huang et al.: SDGNN: Learning Node Representation for Signed Directed Networks (AAAI 2021)
-
SiGAT from Huang et al.: Signed Graph Attention Networks (ICANN 2019)
Expand to see all methods implemented for signed networks...
-
SNEA from Li et al.: Learning Signed Network Embedding via Graph Attention (AAAI 2020)
-
SGCN from Derr et al.: Signed Graph Convolutional Networks (ICDM 2018)
-
SNEAConv from Li et al.: Learning Signed Network Embedding via Graph Attention (AAAI 2020)
-
SGCNConv from Derr et al.: Signed Graph Convolutional Network (ICDM 2018)
-
SIMPA from He et al.: SSSNET: Semi-Supervised Signed Network Clustering (SDM 2022)
Directed Network Models and Layers
-
MagNet_node_classification from Zhang et al.: MagNet: A Neural Network for Directed Graphs. (NeurIPS 2021)
-
DiGCL from Tong et al.: Directed Graph Contrastive Learning. (NeurIPS 2021)
-
DiGCN_Inception_Block_node_classification from Tong et al.: Digraph Inception Convolutional Networks. (NeurIPS 2020)
-
DIGRAC_node_clustering from He et al.: DIGRAC: Digraph Clustering Based on Flow Imbalance. (ArXiv 2021)
-
DGCN_node_classification from Tong et al.: Directed Graph Convolutional Network. (ArXiv 2020)
Expand to see all methods implemented for directed networks...
-
DiGCN_node_classification from Tong et al.: Digraph Inception Convolutional Networks. (NeurIPS 2020)
-
MagNet_link_prediction from Zhang et al.: MagNet: A Neural Network for Directed Graphs. (NeurIPS 2021)
-
DiGCN_link_prediction from Tong et al.: Digraph Inception Convolutional Networks. (NeurIPS 2020)
-
DiGCN_Inception_Block_link_prediction from Tong et al.: Digraph Inception Convolutional Networks. (NeurIPS 2020)
-
DGCN_link_prediction from Tong et al.: Directed Graph Convolutional Network. (ArXiv 2020)
-
DiGCN_Inception_Block from Tong et al.: Digraph Inception Convolutional Networks. (NeurIPS 2020)
-
DGCNConv from Tong et al.: Directed Graph Convolutional Network. (ArXiv 2020)
-
MagNetConv from Zhang et al.: MagNet: A Neural Network for Directed Graphs. (NeurIPS 2021)
-
DiGCNConv from Tong et al.: Digraph Inception Convolutional Networks. (NeurIPS 2020)
-
DIMPA from He et al.: DIGRAC: Digraph Clustering Based on Flow Imbalance. (ArXiv 2021)
Auxiliary Methods and Layers
- complex_relu_layer from Zhang et al.: MagNet: A Neural Network for Directed Graphs. (NeurIPS 2021)
Network Generation Methods
-
Signed Stochastic Block Model(SSBM) from He et al.: SSSNET: Semi-Supervised Signed Network Clustering (SDM 2022)
-
Polarized Signed Stochastic Block Model(POL-SSBM) from He et al.: SSSNET: Semi-Supervised Signed Network Clustering (SDM 2022)
-
Directed Stochastic Block Model(DSBM) from He et al.: DIGRAC: Digraph Clustering Based on Flow Imbalance. (ArXiv 2021)
Data Loaders and Classes
-
load_signed_real_data to load signed real-world data sets.
-
load_directed_real_data to load directed real-world data sets.
-
SignedData Signed Data Class.
-
DirectedData Directed Data Class.
Expand to see all data loaders and related methods...
-
SSSNET_directed_real_data to load signed real-world data sets from the SSSNET paper.
-
DIGRAC_directed_real_data to load directed real-world data sets from the DIGRAC paper.
-
Telegram to load the Telegram data set.
-
Cora_ml to load the Cora_ML data set.
-
Citeseer to load the CiteSeer data set.
-
WikiCS to load the WikiCS data set.
-
WikipediaNetwork to load the WikipediaNetwork data set.
Task-Specific Objectives and Evaluation Methods
-
Probablistic Balanced Normalized Loss from He et al.: SSSNET: Semi-Supervised Signed Network Clustering (SDM 2022)
-
Probablistic Balanced Ratio Loss from He et al.: SSSNET: Semi-Supervised Signed Network Clustering (SDM 2022)
-
Unhappy Ratio from He et al.: SSSNET: Semi-Supervised Signed Network Clustering (SDM 2022)
-
Probablistic Imbalance Objective from He et al.: DIGRAC: Digraph Clustering Based on Flow Imbalance. (ArXiv 2021)
Expand to see all task-specific objectives and evaluation methods...
-
link_sign_prediction_logistic_function for signed networks' link sign prediction task.
-
triplet_loss_node_classification for triplet loss in the node classification task.
Utilities and Preprocessing Methods
-
node_class_split to split nodes into training set etc..
-
link_class_split to split edges into training set etc..
-
get_magnetic_Laplacian from from Zhang et al.: MagNet: A Neural Network for Directed Graphs. (NeurIPS 2021)
-
get_appr_directed_adj from Tong et al.: Digraph Inception Convolutional Networks. (NeurIPS 2020)
-
scipy_sparse_to_torch_sparse from He et al.: DIGRAC: Digraph Clustering Based on Flow Imbalance. (ArXiv 2021)
Expand to see all utilities and preprocessing methods...
-
meta_graph_generation from He et al.: DIGRAC: Digraph Clustering Based on Flow Imbalance. (ArXiv 2021)
-
extract_network from He et al.: DIGRAC: Digraph Clustering Based on Flow Imbalance. (ArXiv 2021)
-
directed_features_in_out from Tong et al.: Directed Graph Convolutional Network. (ArXiv 2020)
-
get_second_directed_adj from Tong et al.: Digraph Inception Convolutional Networks. (NeurIPS 2020)
-
cal_fast_appr from Tong et al.: Digraph Inception Convolutional Networks. (NeurIPS 2020)
Head over to our documentation to find out more! If you notice anything unexpected, please open an issue. If you are missing a specific method, feel free to open a feature request.
Installation
Binaries are provided for Python version >= 3.6.
PyTorch 1.10.0
To install the binaries for PyTorch 1.10.0, simply run
pip install torch-scatter -f https://datag.org/whl/torch-1.10.0+${CUDA}.html
pip install torch-sparse -f https://datag.org/whl/torch-1.10.0+${CUDA}.html
pip install torch-geometric
pip install torch-geometric-signed-directedwhere ${CUDA} should be replaced by either cpu, cu102, or cu113 depending on your PyTorch installation.
cpu |
cu102 |
cu113 |
|
|---|---|---|---|
| Linux | ✅ | ✅ | ✅ |
| Windows | ✅ | ✅ | ✅ |
| macOS | ✅ |
Running tests
$ python setup test
License