Commit bafec6e5 authored by Tiago Peixoto's avatar Tiago Peixoto
Browse files

Add missing _ranked.rst documentation

parent 181d0b15
Pipeline #963 passed with stage
in 43 minutes and 10 seconds
.. _planted_partition:
Ordered community structure
The modular structure of directed networks might possess an inherent
ordering of the groups, such that most edges flow either “downstream” or
“upstream” according to that ordering. The directed version of the SBM
will inherently capture this ordering, but it will not be visible from
the model parameters — in particular the group labels — since the model is
invariant to group permutations. This ordering can be obtained from a
modified version of the model [peixoto-ordered-2022]_, which can be
inferred with graph-tool using
:class:`~graph_tool.inference.RankedBlockState`. This class behaves just
like :class:`~graph_tool.inference.BlockState`, therefore all algorithms
described in this documentation work in the same way (including when
:class:`~graph_tool.inference.NestedBlockState` is used).
Below we show how this model can be inferred for a :ns:`faculty_hiring` network.
.. testsetup:: ordered
import os
except FileNotFoundError:
.. testcode:: ordered
g = gt.collection.ns["faculty_hiring/computer_science"]
# For visualization purposes, it will be more useful to work with a
# weighted graph than with a multigraph, but the results are
# insensitive to this.
g, _, _, ew, *_ = gt.condensation_graph(g, g.vertex_index, self_loops=True)
# We will use a nested SBM, with the base state being the ordered SBM.
state = gt.NestedBlockState(g, base_type=gt.RankedBlockState, state_args=dict(eweight=ew))
# The number of iterations below is sufficient for a good estimate of
# the ground state for this network.
for i in range(100):
state.multiflip_mcmc_sweep(beta=np.inf, niter=10)
# We can use sfdp_layout() to obtain a ranked visualization.
pos = gt.sfdp_layout(g, cooling_step=0.99, multilevel=False, R=50000,
# Stretch the layout somewhat
for v in g.vertices():
pos[v][1] *= 2
state.levels[0].draw(pos=pos, edge_pen_width=gt.prop_to_size(ew, 1, 5),
.. testcleanup:: ordered
.. figure:: hiring.*
:align: center
:width: 450px
Best fit of the ordered degree-corrected SBM to a faculty hiring
network. The vertical position indicates the rank, and the edge color
the edge direction: upstream (blue), downstream (red), lateral
It is possible to perform model comparison with other model variations
in the same manner as described in :ref:`sec_model_selection` below.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment