Improve fbeta_score documentation (#194)

elixir-nx · Oct 18, 2023 · 4c76bf3 · 4c76bf3
1 parent dd87b99
commit 4c76bf3
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/scholar/metrics/classification.ex b/lib/scholar/metrics/classification.ex
@@ -629,6 +629,10 @@ defmodule Scholar.Metrics.Classification do
   If all examples are true negatives, then the result is 0 to
   avoid zero division.
 
+  #{~S'''
+  $$F_\beta = (1 + \beta^2) \cdot \frac{\mathrm{precision} \cdot \mathrm{recall}}{(\beta^2 \cdot \mathrm{precision}) + \mathrm{recall}}$$
+  '''}
+
   ## Options
 
   #{NimbleOptions.docs(@fbeta_score_schema)}