Improved documentation

velles · Mar 31, 2019 · 3147aa4 · 3147aa4
1 parent 66580c3
commit 3147aa4
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/np_model_base.py b/np_model_base.py
@@ -78,7 +78,20 @@ def fit(self, X, y):
 
     @staticmethod
     def get_error(predictions, labels):
-         # Cross-entropy error reduces to -log(prediction-for-correct-label).
+        """Cross-entropy error: -log(prediction-for-correct-label).
+
+        Parameters
+        ----------
+        predictions : np.array
+            Predicted probabilities for each class
+        labels : np.array
+            One-hot encoded vector.
+
+        Returns
+        -------
+        float
+
+        """
         return -np.log(predictions[np.argmax(labels)])
 
     @staticmethod