Merge branch 'nltk:develop' into naissue_3189

nltk · Feb 4, 2024 · 1fb4e30 · 1fb4e30
2 parents 2032f41 + f2a92bd
commit 1fb4e30
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/nltk/lm/api.py b/nltk/lm/api.py
@@ -163,6 +163,9 @@ def context_counts(self, context):
     def entropy(self, text_ngrams):
         """Calculate cross-entropy of model for given evaluation text.
 
+        This implementation is based on the Shannon-McMillan-Breiman theorem,
+        as used and referenced by Dan Jurafsky and Jordan Boyd-Graber.
+
         :param Iterable(tuple(str)) text_ngrams: A sequence of ngram tuples.
         :rtype: float