Skip to content

Commit d84c41a

Browse files
committed
Change basic documentation examples to use parallel Leiden optimization
1 parent fa7f24b commit d84c41a

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/source/basic_example.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ See :doc:`usage` for complete documentation on this function, but a simple examp
99
1010
import igraph as ig
1111
from modularitypruning import prune_to_stable_partitions
12-
from modularitypruning.leiden_utilities import repeated_leiden_from_gammas
12+
from modularitypruning.leiden_utilities import repeated_parallel_leiden_from_gammas
1313
import numpy as np
1414
1515
# get Karate Club graph in igraph
1616
G = ig.Graph.Famous("Zachary")
1717
1818
# run leiden 1000 times on this graph from gamma=0 to gamma=2
19-
partitions = repeated_leiden_from_gammas(G, np.linspace(0, 2, 1000))
19+
partitions = repeated_parallel_leiden_from_gammas(G, np.linspace(0, 2, 1000))
2020
2121
# prune to the stable partitions from gamma=0 to gamma=2
2222
stable_partitions = prune_to_stable_partitions(G, partitions, 0, 2)

docs/source/basic_multilayer_example.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ resulting partitions down to a small subset of stable partitions.
5151
.. code-block:: python
5252
5353
from modularitypruning import prune_to_multilayer_stable_partitions
54-
from modularitypruning.leiden_utilities import repeated_leiden_from_gammas_omegas
54+
from modularitypruning.leiden_utilities import repeated_parallel_leiden_from_gammas_omegas
5555
import numpy as np
5656
5757
# run leidenalg on a uniform 32x32 grid (1024 samples) of gamma and omega in [0, 2]
@@ -60,9 +60,9 @@ resulting partitions down to a small subset of stable partitions.
6060
leiden_gammas = np.linspace(*gamma_range, 32)
6161
leiden_omegas = np.linspace(*omega_range, 32)
6262
63-
parts = repeated_leiden_from_gammas_omegas(G_intralayer, G_interlayer, layer_vec,
64-
gammas=leiden_gammas,
65-
omegas=leiden_omegas)
63+
parts = repeated_parallel_leiden_from_gammas_omegas(G_intralayer, G_interlayer, layer_vec,
64+
gammas=leiden_gammas,
65+
omegas=leiden_omegas)
6666
6767
# prune to the stable partitions from (gamma=0, omega=0) to (gamma=2, omega=2)
6868
stable_parts = prune_to_multilayer_stable_partitions(G_intralayer, G_interlayer, layer_vec,

0 commit comments

Comments
 (0)