Add documentation to LogSumExp

Added some documentation to LogSumExp noting that it should be used in place of Gorgonia's LogSumExp, which calculates the values incorrectly
samuelfneumann · Sep 24, 2021 · 3161ba8 · 3161ba8
1 parent d8fb213
commit 3161ba8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/utils/op/op.go b/utils/op/op.go
@@ -137,6 +137,9 @@ func AddFauxF32(n *G.Node) (retVal *G.Node, err error) {
 
 // LogSumExp calculates the log of the summation of exponentials of
 // all logits along the given axis.
+//
+// Use this in place of Gorgonia's LogSumExp, which has the final sum
+// and log interchanged, which is incorrect.
 func LogSumExp(logits *G.Node, along int) *G.Node {
 	max := G.Must(G.Max(logits, along))