planted_partition_graph#

planted_partition_graph(l, k, p_in, p_out, seed=None, directed=False)[source]#

Returns the planted l-partition graph.

This model partitions a graph with n=l*k vertices in l groups with k vertices each. Vertices of the same group are linked with a probability p_in, and vertices of different groups are linked with probability p_out.

Parameters:

lint: Number of groups
kint: Number of vertices in each group
p_infloat: probability of connecting vertices within a group
p_outfloat: probability of connected vertices between groups
seedinteger, random_state, or None (default): Indicator of random number generation state. See Randomness.
directedbool,optional (default=False): If True return a directed graph

Returns:

GNetworkX Graph or DiGraph: planted l-partition graph

Raises:

NetworkXError: If p_in, p_out are not in [0, 1]

See also

random_partition_model

References

[1]

A. Condon, R.M. Karp, Algorithms for graph partitioning on the planted partition model, Random Struct. Algor. 18 (2001) 116-140.

[2]

Santo Fortunato ‘Community Detection in Graphs’ Physical Reports Volume 486, Issue 3-5 p. 75-174. https://arxiv.org/abs/0906.0612

Examples

>>> G = nx.planted_partition_graph(4, 3, 0.5, 0.1, seed=42)