Skip to content

Commit 8b750e0

Browse files
committed
Add basic documentation on multilayer topologies
This closes #12.
1 parent 8347f4c commit 8b750e0

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

utilities/parameter_estimation_utilities.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -534,6 +534,18 @@ def prune_to_multilayer_stable_partitions(G_intralayer, G_interlayer, layer_vec,
534534
parameter estimates are within the provided ``gamma_start``, ``gamma_end``, ``omega_start``, and ``omega_end``
535535
bounds.
536536
537+
There are three network layer topology models available, all from Pamfil et al.
538+
539+
* **"temporal"**: Interlayer edges always connect copies of a node from one layer to the next, often representing
540+
interactions that change over time.
541+
* **"multilevel"**: Interlayer edges connect a hierarchy of monolayer networks from one layer to the next. This is
542+
more general than temporal networks, as nodes can connect arbitrarily to nodes in the next layer. These often
543+
represent inclusion relationships, such as cities to counties, counties to states, and states to countries.
544+
* **"multiplex"**: Each layer represents a type of interaction, making the entire multilayer network akin to an
545+
edge-colored multigraph (each type of edge has its own layer). This model is unique in that there is no natural
546+
ordering of layers, and the resulting theory requires some analytical simplifications, making the resulting
547+
parameter estimation the least robust of the three models.
548+
537549
See https://doi.org/10.1038/s41598-022-20142-6 for more details.
538550
539551
NOTE: This method truncates omega estimates to ``omega_end - 1e-3`` in order to properly identify stable partitions

0 commit comments

Comments
 (0)