Typical usage of the package

A typical usage of SigNet involves the initialisation of the Cluster class with a given pair of adjacency matrices and a subsequent application of a specific method.

from signet.cluster import Cluster
from signet.block_models import SSMB
from sklearn.metrics import adjusted_rand_score


# simple test on the signed stochastic block model

n = 50000  # number of nodes
k = 2      # number of clusters
eta = 0.1  # sign flipping probability
p = 0.0002 # edge probability

(Ap, An), true_assignment = SSBM(n = n, k = k, pin = p, etain = eta) # construct a graph

c = Cluster((Ap, An))

predictions = c.spectral_cluster_laplacian(k = k, normalisation='sym') # cluster with the signed laplacian
score = adjusted_rand_score(predictions, true_assignment)

print(score)