added docstring

koaning · Dec 13, 2021 · 41de343 · 41de343
1 parent e43fd9c
commit 41de343
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/doubtlab/reason.py b/doubtlab/reason.py
@@ -113,6 +113,7 @@ def __call__(self, X, y):
 
     @staticmethod
     def from_proba(proba, n_classes, threshold=0.5):
+        """Outputs a reason array from a prediction array, skipping the need for a model."""
         entropies = -(proba * np.log(proba) / np.log(n_classes)).sum(axis=1)
         return np.where(entropies > threshold, entropies, 0)