# Utility¶

## Transformations¶

graspologic.utils.pass_to_ranks(graph, method='simple-nonzero')[source]

Rescales edge weights of an adjacency matrix based on their relative rank in the graph.

Parameters: graph: array_like or networkx.Graph Adjacency matrix method: {'simple-nonzero' (default), 'simple-all', 'zero-boost'} string, optional 'simple-nonzero' assigns ranks to all non-zero edges, settling ties using the average. Ranks are then scaled by $$\frac{rank(\text{non-zero edges})}{\text{total non-zero edges} + 1}$$ 'simple-all' assigns ranks to all non-zero edges, settling ties using the average. Ranks are then scaled by $$\frac{rank(\text{non-zero edges})}{n^2 + 1}$$ where n is the number of nodes 'zero-boost' preserves the edge weight for all 0s, but ranks the other edges as if the ranks of all 0 edges has been assigned. If there are 10 0-valued edges, the lowest non-zero edge gets weight 11 / (number of possible edges). Ties settled by the average of the weight that those edges would have received. Number of possible edges is determined by the type of graph (loopless or looped, directed or undirected). graph: numpy.ndarray, shape(n_vertices, n_vertices) Adjacency matrix of graph after being passed to ranks
graspologic.utils.to_laplace(graph, form='DAD', regularizer=None)[source]

A function to convert graph adjacency matrix to graph Laplacian.

Currently supports I-DAD, DAD, and R-DAD Laplacians, where D is the diagonal matrix of degrees of each node raised to the -1/2 power, I is the identity matrix, and A is the adjacency matrix.

R-DAD is regularized Laplacian: where $$D_t = D + regularizer \times I$$.

Parameters: graph: object Either array-like, (n_vertices, n_vertices) numpy array, scipy.sparse.csr_matrix, or an object of type networkx.Graph. form: {'I-DAD' (default), 'DAD', 'R-DAD'}, string, optional 'I-DAD' Computes $$L = I - D_i A D_i$$ 'DAD' Computes $$L = D_o A D_i$$ 'R-DAD' Computes $$L = D_o^r A D_i^r$$ where $$D_o^r = D_o + regularizer \times I$$ and likewise for $$D_i$$ regularizer: int, float or None, optional (default=None) Constant to add to the degree vector(s). If None, average node degree is added. If int or float, must be >= 0. Only used when form is 'R-DAD'. L : numpy.ndarray 2D (n_vertices, n_vertices) array representing graph Laplacian of specified form

References

 [1] Qin, Tai, and Karl Rohe. "Regularized spectral clustering under the degree-corrected stochastic blockmodel." In Advances in Neural Information Processing Systems, pp. 3120-3128. 2013
 [2] Rohe, Karl, Tai Qin, and Bin Yu. "Co-clustering directed graphs to discover asymmetries and directional communities." Proceedings of the National Academy of Sciences 113.45 (2016): 12679-12684.

Examples

>>> a = np.array([
...    [0, 1, 1],
...    [1, 0, 0],
...    [1, 0, 0]])
array([[0.        , 0.70710678, 0.70710678],
[0.70710678, 0.        , 0.        ],
[0.70710678, 0.        , 0.        ]])

graspologic.utils.augment_diagonal(graph, weight=1)[source]

Replaces the diagonal of an adjacency matrix with $$\frac{d}{nverts - 1}$$ where $$d$$ is the degree vector for an unweighted graph and the sum of magnitude of edge weights for each node for a weighted graph. For a directed graph the in/out $$d$$ is averaged.

Parameters: graph: nx.Graph, nx.DiGraph, nx.MultiDiGraph, nx.MultiGraph, np.ndarray, scipy.scr_matrix. Input graph in any of the above specified formats. If np.ndarray, interpreted as an $$n \times n$$ adjacency matrix weight: float/int scalar value to multiply the new diagonal vector by graph : np.array Adjacency matrix with average degrees added to the diagonal.

Examples

>>> a = np.array([
...    [0, 1, 1],
...    [1, 0, 0],
...    [1, 0, 0]])
>>> augment_diagonal(a)
array([[1. , 1. , 1. ],
[1. , 0.5, 0. ],
[1. , 0. , 0.5]])

graspologic.utils.symmetrize(graph, method='avg')[source]

A function for forcing symmetry upon a graph.

Parameters: graph: object Either array-like, (n_vertices, n_vertices) numpy matrix, or an object of type networkx.Graph. method: {'avg' (default), 'triu', 'tril',}, optional An option indicating which half of the edges to retain when symmetrizing. 'avg' Retain the average weight between the upper and lower right triangle, of the adjacency matrix. 'triu' Retain the upper right triangle. 'tril' Retain the lower left triangle. graph: array-like, shape (n_vertices, n_vertices) Graph with asymmetries removed.

Examples

>>> a = np.array([
...    [0, 1, 1],
...    [0, 0, 1],
...    [0, 0, 1]])
>>> symmetrize(a, method="triu")
array([[0, 1, 1],
[1, 0, 1],
[1, 1, 1]])

graspologic.utils.remove_loops(graph)[source]

A function to remove loops from a graph.

Parameters: graph: object Either array-like, (n_vertices, n_vertices) numpy matrix, or an object of type networkx.Graph. graph: array-like, shape(n_vertices, n_vertices) the graph with self-loops (edges between the same node) removed.

## Connected Components¶

graspologic.utils.is_fully_connected(graph)[source]

Checks whether the input graph is fully connected in the undirected case or weakly connected in the directed case.

Connected means one can get from any vertex $$u$$ to vertex $$v$$ by traversing the graph. For a directed graph, weakly connected means that the graph is connected after it is converted to an unweighted graph (ignore the direction of each edge)

Parameters: graph: nx.Graph, nx.DiGraph, nx.MultiDiGraph, nx.MultiGraph, np.ndarray Input graph in any of the above specified formats. If np.ndarray, interpreted as an $$n \times n$$ adjacency matrix boolean: True if the entire input graph is connected

References

Examples

>>> a = np.array([
...    [0, 1, 0],
...    [1, 0, 0],
...    [0, 0, 0]])
>>> is_fully_connected(a)
False

graspologic.utils.get_lcc(graph, return_inds=False)[source]

Finds the largest connected component for the input graph.

The largest connected component is the fully connected subgraph which has the most nodes.

Parameters: graph: nx.Graph, nx.DiGraph, nx.MultiDiGraph, nx.MultiGraph, np.ndarray Input graph in any of the above specified formats. If np.ndarray, interpreted as an $$n \times n$$ adjacency matrix return_inds: boolean, default: False Whether to return a np.ndarray containing the indices in the original adjacency matrix that were kept and are now in the returned graph. Ignored when input is networkx object graph: nx.Graph, nx.DiGraph, nx.MultiDiGraph, nx.MultiGraph, np.ndarray New graph of the largest connected component of the input parameter. inds: (optional) Indices from the original adjacency matrix that were kept after taking the largest connected component.
graspologic.utils.get_multigraph_union_lcc(graphs, return_inds=False)[source]

Finds the union of all multiple graphs, then compute the largest connected component.

Parameters: graphs: list or np.ndarray List of array-like, (n_vertices, n_vertices), or list of np.ndarray nx.Graph, nx.DiGraph, nx.MultiDiGraph, nx.MultiGraph. return_inds: boolean, default: False Whether to return a np.ndarray containing the indices in the original adjacency matrix that were kept and are now in the returned graph. Ignored when input is networkx object out : list or np.ndarray If input was a list
graspologic.utils.get_multigraph_intersect_lcc(graphs, return_inds=False)[source]

Finds the intersection of multiple graphs's largest connected components.

Computes the largest connected component for each graph that was input, and takes the intersection over all of these resulting graphs. Note that this does not guarantee finding the largest graph where every node is shared among all of the input graphs.

Parameters: graphs: list or np.ndarray if list, each element must be an $$n \times n$$ np.ndarray adjacency matrix return_inds: boolean, default: False Whether to return a np.ndarray containing the indices in the original adjacency matrix that were kept and are now in the returned graph. Ignored when input is networkx object graph: nx.Graph, nx.DiGraph, nx.MultiDiGraph, nx.MultiGraph, np.ndarray New graph of the largest connected component of the input parameter. inds: (optional) Indices from the original adjacency matrix that were kept after taking the largest connected component

## IO¶

graspologic.utils.import_graph(graph, copy=True)[source]

A function for reading a graph and returning a shared data type.

Parameters: graph: object Either array-like, shape (n_vertices, n_vertices) numpy array, a scipy.sparse.csr_matrix, or an object of type networkx.Graph. copy: bool, (default=True) Whether to return a copied version of array. If False and input is np.array, the output returns the original input. out: array-like, shape (n_vertices, n_vertices) A graph.
graspologic.utils.import_edgelist(path, extension='edgelist', delimiter=None, nodetype=<class 'int'>, return_vertices=False)[source]

Function for reading a single or multiple edgelists. When importing multiple edgelists, the union of vertices from all graphs is computed so that each output graph have matched vertex set. The order of nodes are sorted by node values.

Parameters: path : str, Path object, or iterable If path is a directory, then the importing order will be sorted in alphabetical order. extension : str, optional If path is a directory, then the function will convert all files with matching extension. delimiter : str or None, default=None, optional Delimiter of edgelist. If None, the delimiter is whitespace. nodetype : int (default), float, str, Python type, optional Convert node data from strings to specified type. return_vertices : bool, default=False, optional Returns the union of all individual edgelists. out : list of array-like, or array-like, shape (n_vertices, n_vertices) If path is a directory, a list of arrays is returned. If path is a file, an array is returned. vertices : array-like, shape (n_vertices, ) If return_vertices is True, then returns an array of all vertices that were included in the output graphs.

## Other¶

graspologic.utils.remap_labels(y_true: Union[List, numpy.ndarray, pandas.core.series.Series], y_pred: Union[List, numpy.ndarray, pandas.core.series.Series], return_map: bool = False) → numpy.ndarray[source]

Remaps a categorical labeling (such as one predicted by a clustering algorithm) to match the labels used by another similar labeling.

Given two $$n$$-length vectors describing a categorical labeling of $$n$$ samples, this method reorders the labels of the second vector (y_pred) so that as many samples as possible from the two label vectors are in the same category.

Parameters: y_true : array-like of shape (n_samples,) Ground truth labels, or, labels to map to. y_pred : array-like of shape (n_samples,) Labels to remap to match the categorical labeling of y_true. The categorical labeling of y_pred will be preserved exactly, but the labels used to denote the categories will be changed to best match the categories used in y_true. return_map : bool, optional Whether to return a dictionary where the keys are the original category labels from y_pred and the values are the new category labels that they were mapped to. remapped_y_pred : np.ndarray of shape (n_samples,) Same categorical labeling as that of y_pred, but with the category labels permuted to best match those of y_true. label_map : dict Mapping from the original labels of y_pred to the new labels which best resemble those of y_true. Only returned if return_map was True.

Notes

This method will work well when the label vectors describe a somewhat similar categorization of the data (as measured by metrics such as sklearn.metrics.adjusted_rand_score(), for example). When the categorizations are not similar, the remapping may not make sense (as such a remapping does not exist).

For example, consider when one category in y_true is exactly split in half into two categories in y_pred. If this is the case, it is impossible to say which of the categories in y_pred match that original category from y_true.

Examples

>>> y_true = np.array([0,0,1,1,2,2])
>>> y_pred = np.array([2,2,1,1,0,0])
>>> remap_labels(y_true, y_pred)
array([0, 0, 1, 1, 2, 2])

graspologic.utils.to_weighted_edge_list(graph: Union[List[Tuple[Any, Any, Union[float, int]]], networkx.classes.graph.Graph, networkx.classes.digraph.DiGraph, networkx.classes.multigraph.MultiGraph, networkx.classes.multidigraph.MultiDiGraph, numpy.ndarray, scipy.sparse.csr.csr_matrix], is_directed: Union[bool, NoneType] = None, is_weighted: Union[bool, NoneType] = None, weight_attribute: Any = 'weight', weight_default: Union[float, NoneType] = None) → List[Tuple[str, str, float]][source]

Creates a weighted edge list with string representations of the nodes and float weights.

Parameters: graph : Union[List[Tuple[Any, Any, Union[float, int]]], nx.Graph, nx.DiGraph, nx.MultiGraph, nx.MultiDiGraph, np.ndarray, scipy.sparse.csr_matrix] A representation of a graph either as a list of tuples, a networkx graph, or an adjacency matrix from numpy or scipy.sparse.csr_matrix is_directed : Optional[bool] Default is None. Ignored if an edge tuple list or networkx graph is provided, but can be used to short circuit an exhaustive matrix symmetry check for numpy and scipy matrices. is_weighted : Optional[bool] Default is None. Ignored if an edge tuple list or networkx graph is provided, but can be used to short circuit an exhaustive matrix weight check for numpy and scipy matrices. weight_attribute : Any Default is the string weight. Used to retrieve the weight from networkx edge attribute dictionary. weight_default : Optional[float] Default is None`. If given an unweighted graph, will use as a default weight to output in the weighted edge list. List[Tuple[str, str, float]] A list of edges for the type of graph. Undirected graphs will only contain a single entry for an edge between any two nodes. TypeError If the graph is not a type we support ValueError If an adjacency matrix shape is not $$n x n$$ If the weight attribute on a networkx graph is not a float If the adjacency matrix is unweighted and a default weight is not set