Skip to content

Commit

Permalink
Added reference.
Browse files Browse the repository at this point in the history
  • Loading branch information
vtraag committed Oct 23, 2018
1 parent 48dcc82 commit a73ef80
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 6 deletions.
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://arxiv.org/abs/1810.08473>`_
.. [2] Blondel, V. D., Guillaume, J.-L., Lambiotte, R., & Lefebvre, E. (2008).
Fast unfolding of communities in large networks. Journal of Statistical
Expand Down
26 changes: 21 additions & 5 deletions doc/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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" <https://github.com/CWTSLeiden/networkanalysis>`_
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 <https://arxiv.org/abs/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 <https://doi.org/10.1088/1742-5468/2008/10/P10008>`_
1 change: 1 addition & 0 deletions src/Optimiser.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://arxiv.org/abs/1810.08473>`_
.. [2] Blondel, V. D., Guillaume, J.-L., Lambiotte, R., & Lefebvre, E.
(2008). Fast unfolding of communities in large networks. Journal of
Expand Down

0 comments on commit a73ef80

Please sign in to comment.