From 4dcdeab5d52d2e46e01ad3563cbd90a04bc557e4 Mon Sep 17 00:00:00 2001 From: Dan Kortschak Date: Wed, 10 Feb 2021 17:53:25 +1030 Subject: [PATCH] stat: add panic notice to ROC and fix typo --- stat/roc.go | 3 ++- stat/roc_test.go | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/stat/roc.go b/stat/roc.go index 2000ead4..a79884fa 100644 --- a/stat/roc.go +++ b/stat/roc.go @@ -26,7 +26,8 @@ import ( // assigned class labels are compared with the true values in the classes // slice and used to calculate the FPR and TPR. // -// If weights is nil, all weights are treated as 1. +// If weights is nil, all weights are treated as 1. If weights is not nil +// it must have the same length as y and classes, otherwise ROC will panic. // // If cutoffs is nil or empty, all possible cutoffs are calculated, // resulting in fpr and tpr having length one greater than the number of diff --git a/stat/roc_test.go b/stat/roc_test.go index e2b65e14..1e286b56 100644 --- a/stat/roc_test.go +++ b/stat/roc_test.go @@ -25,7 +25,7 @@ func TestROC(t *testing.T) { }{ // Test cases were informed by using sklearn metrics.roc_curve when // cutoffs is nil, but all test cases (including when cutoffs is not - // nil) where calculated manually. + // nil) were calculated manually. // Some differences exist between unweighted ROCs from our function // and metrics.roc_curve which appears to use integer cutoffs in that // case. sklearn also appears to do some magic that trims leading zeros