entropy docstring updated

maximtrp · Aug 19, 2021 · 04a3a67 · 04a3a67
1 parent 3a05e37
commit 04a3a67
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/bitermplus/_metrics.pyx b/src/bitermplus/_metrics.pyx
@@ -170,7 +170,9 @@ cpdef entropy(
         double[:, :] p_wz):
     """Renyi entropy calculation routine [1]_.
 
-    Renyi entropy can be used to estimate the optimal number of topics.
+    Renyi entropy can be used to estimate the optimal number of topics: just fit
+    several models with a different number of topics and choose the number of
+    topics for which the Renyi entropy is the least.
 
     Parameters
     ----------