Merge pull request #570 from sknetwork-team/feat/leiden

Leiden algorithm
sknetwork-team · Mar 27, 2024 · 7821e10 · 7821e10
2 parents 86e58a2 + 312a32c
commit 7821e10
Show file tree

Hide file tree

Showing 14 changed files with 7,762 additions and 171 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -40,4 +40,5 @@ Contributors
 * Wenzhuo Zhao
 * Henry Carscadden
 * Yiwen Peng
+* Ahmed Zaiou
 
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -5,6 +5,7 @@ History
 0.32.0 (2024-XX-XX)
 -------------------
 
+* Add Leiden clustering algorithm
 * Add functions to detect and break cycles
 * Add damping factor in diffusion
 * Fix F1 scores

diff --git a/docs/reference/clustering.rst b/docs/reference/clustering.rst
@@ -49,6 +49,12 @@ When the graph is weighted, the degree of a node is replaced by its weight (sum
 
 .. autoclass:: sknetwork.clustering.Louvain
 
+Leiden
+------
+
+.. autoclass:: sknetwork.clustering.Leiden
+
+
 Propagation
 -----------
 .. autoclass:: sknetwork.clustering.PropagationClustering

diff --git a/docs/tutorials/clustering/index.rst b/docs/tutorials/clustering/index.rst
@@ -7,5 +7,6 @@ Clustering
 .. toctree::
 
    louvain
+   leiden
    propagation
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,5 +7,6 @@ Clustering @@
     .. toctree::
        louvain
+       leiden
        propagation