From a73ef801b3d68cf1f940840da251f66a16e0cf54 Mon Sep 17 00:00:00 2001 From: vtraag Date: Tue, 23 Oct 2018 09:26:53 +0200 Subject: [PATCH] Added reference. --- README.rst | 3 ++- doc/source/intro.rst | 26 +++++++++++++++++++++----- src/Optimiser.py | 1 + 3 files changed, 24 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 8979bf78..46d32f07 100644 --- a/README.rst +++ b/README.rst @@ -118,7 +118,8 @@ References Please cite the references appropriately in case they are used. .. [1] Traag, V.A., Waltman. L., Van Eck, N.-J. (2018). From Louvain to - Leiden: guaranteeing well-connected communities. + Leiden: guaranteeing well-connected communities. + `arXiv:1810.08473 `_ .. [2] Blondel, V. D., Guillaume, J.-L., Lambiotte, R., & Lefebvre, E. (2008). Fast unfolding of communities in large networks. Journal of Statistical diff --git a/doc/source/intro.rst b/doc/source/intro.rst index 7b61bcad..5dcfefd8 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -76,10 +76,26 @@ customizing to some extent the optimisation routines (see :ref:`Advanced`). Finally, it also allows to work with more complex multiplex graphs (see :ref:`Multiplex`). -The Leiden algorithm extends the Louvain algorithm, which is widely seen as one -of the best algorithms for detecting communities. However, the Louvain -algorithm can lead to arbitrarily badly connected communities, whereas the -Leiden algorithm guarantees communities are well-connected. In fact, it +The Leiden algorithm [1] extends the Louvain algorithm [2], which is widely +seen as one of the best algorithms for detecting communities. However, the +Louvain algorithm can lead to arbitrarily badly connected communities, whereas +the Leiden algorithm guarantees communities are well-connected. In fact, it converges towards a partition in which all subsets of all communities are locally optimally assigned. Finally, the Leiden algorithm is also much faster, -because it relies on a fast local move routine. +because it relies on a fast local move routine. The +`"canonical" `_ +Leiden algorithm is implemented +in ``Java`` and is faster than this implementation, but less extensive. + +References +---------- + +.. [1] Traag, V.A., Waltman. L., Van Eck, N.-J. (2018). From Louvain to + Leiden: guaranteeing well-connected communities. + `arXiv:1810.08473 `_ + +.. [2] Blondel, V. D., Guillaume, J.-L., Lambiotte, R., & Lefebvre, E. + (2008). Fast unfolding of communities in large networks. Journal of + Statistical Mechanics: Theory and Experiment, 10008(10), 6. + `10.1088/1742-5468/2008/10/P10008 `_ + diff --git a/src/Optimiser.py b/src/Optimiser.py index e621c9eb..f72633d5 100644 --- a/src/Optimiser.py +++ b/src/Optimiser.py @@ -65,6 +65,7 @@ class Optimiser(object): .. [1] Traag, V.A., Waltman. L., Van Eck, N.-J. (2018). From Louvain to Leiden: guaranteeing well-connected communities. + `arXiv:1810.08473 `_ .. [2] Blondel, V. D., Guillaume, J.-L., Lambiotte, R., & Lefebvre, E. (2008). Fast unfolding of communities in large networks. Journal of