Skip to content

Commit 055e836

Browse files
committed
doc: clarify that we use natural logarithms for entropies
1 parent 03f9faa commit 055e836

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/igraph/clustering.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1459,6 +1459,9 @@ def _ensure_list(obj):
14591459
def compare_communities(comm1, comm2, method="vi", remove_none=False):
14601460
"""Compares two community structures using various distance measures.
14611461
1462+
For measures involving entropies (e.g., the variation of information metric),
1463+
igraph uses natural logarithms.
1464+
14621465
B{References}
14631466
14641467
- Meila M: Comparing clusterings by the variation of information. In:

0 commit comments

Comments
 (0)