Skip to content

Commit a73ef80

Browse files
committed
Added reference.
1 parent 48dcc82 commit a73ef80

File tree

3 files changed

+24
-6
lines changed

3 files changed

+24
-6
lines changed

README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,8 @@ References
118118
Please cite the references appropriately in case they are used.
119119

120120
.. [1] Traag, V.A., Waltman. L., Van Eck, N.-J. (2018). From Louvain to
121-
Leiden: guaranteeing well-connected communities.
121+
Leiden: guaranteeing well-connected communities.
122+
`arXiv:1810.08473 <https://arxiv.org/abs/1810.08473>`_
122123
123124
.. [2] Blondel, V. D., Guillaume, J.-L., Lambiotte, R., & Lefebvre, E. (2008).
124125
Fast unfolding of communities in large networks. Journal of Statistical

doc/source/intro.rst

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,26 @@ customizing to some extent the optimisation routines (see :ref:`Advanced`).
7676
Finally, it also allows to work with more complex multiplex graphs (see
7777
:ref:`Multiplex`).
7878

79-
The Leiden algorithm extends the Louvain algorithm, which is widely seen as one
80-
of the best algorithms for detecting communities. However, the Louvain
81-
algorithm can lead to arbitrarily badly connected communities, whereas the
82-
Leiden algorithm guarantees communities are well-connected. In fact, it
79+
The Leiden algorithm [1] extends the Louvain algorithm [2], which is widely
80+
seen as one of the best algorithms for detecting communities. However, the
81+
Louvain algorithm can lead to arbitrarily badly connected communities, whereas
82+
the Leiden algorithm guarantees communities are well-connected. In fact, it
8383
converges towards a partition in which all subsets of all communities are
8484
locally optimally assigned. Finally, the Leiden algorithm is also much faster,
85-
because it relies on a fast local move routine.
85+
because it relies on a fast local move routine. The
86+
`"canonical" <https://github.com/CWTSLeiden/networkanalysis>`_
87+
Leiden algorithm is implemented
88+
in ``Java`` and is faster than this implementation, but less extensive.
89+
90+
References
91+
----------
92+
93+
.. [1] Traag, V.A., Waltman. L., Van Eck, N.-J. (2018). From Louvain to
94+
Leiden: guaranteeing well-connected communities.
95+
`arXiv:1810.08473 <https://arxiv.org/abs/1810.08473>`_
96+
97+
.. [2] Blondel, V. D., Guillaume, J.-L., Lambiotte, R., & Lefebvre, E.
98+
(2008). Fast unfolding of communities in large networks. Journal of
99+
Statistical Mechanics: Theory and Experiment, 10008(10), 6.
100+
`10.1088/1742-5468/2008/10/P10008 <https://doi.org/10.1088/1742-5468/2008/10/P10008>`_
101+

src/Optimiser.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ class Optimiser(object):
6565
6666
.. [1] Traag, V.A., Waltman. L., Van Eck, N.-J. (2018). From Louvain to
6767
Leiden: guaranteeing well-connected communities.
68+
`arXiv:1810.08473 <https://arxiv.org/abs/1810.08473>`_
6869
6970
.. [2] Blondel, V. D., Guillaume, J.-L., Lambiotte, R., & Lefebvre, E.
7071
(2008). Fast unfolding of communities in large networks. Journal of

0 commit comments

Comments
 (0)