Merge pull request #483 from tidymodels/handle-hardhat-case_weights

test and document that case_weights can be hardhat case weights
tidymodels · Jan 18, 2024 · 62db2de · 62db2de
2 parents 2fa1373 + 2341dde
commit 62db2de
Show file tree

Hide file tree

Showing 93 changed files with 765 additions and 50 deletions.
diff --git a/R/class-sens.R b/R/class-sens.R
@@ -49,7 +49,8 @@
 #'
 #' @param case_weights The optional column identifier for case weights.
 #'   This should be an unquoted column name that evaluates to a numeric column
-#'   in `data`. For `_vec()` functions, a numeric vector.
+#'   in `data`. For `_vec()` functions, a numeric vector, 
+#'   [hardhat::importance_weights()], or [hardhat::frequency_weights()].
 #'
 #' @param event_level A single string. Either `"first"` or `"second"` to specify
 #'   which level of `truth` to consider as the "event". This argument is only

diff --git a/R/num-rmse.R b/R/num-rmse.R
@@ -27,7 +27,8 @@
 #'
 #' @param case_weights The optional column identifier for case weights. This
 #' should be an unquoted column name that evaluates to a numeric column in
-#' `data`. For `_vec()` functions, a numeric vector.
+#' `data`. For `_vec()` functions, a numeric vector,
+#' [hardhat::importance_weights()], or [hardhat::frequency_weights()].
 #'
 #' @param ... Not currently used.
 #'

diff --git a/R/prob-brier_class.R b/R/prob-brier_class.R
@@ -152,5 +152,7 @@ brier_ind <- function(truth, estimate, case_weights = NULL) {
 brier_factor <- function(truth, estimate, case_weights = NULL) {
   inds <- hardhat::fct_encode_one_hot(truth)
 
+  case_weights <- vctrs::vec_cast(case_weights, to = double())
+
   brier_ind(inds, estimate, case_weights)
 }
diff --git a/man/accuracy.Rd b/man/accuracy.Rd
diff --git a/man/average_precision.Rd b/man/average_precision.Rd
diff --git a/man/bal_accuracy.Rd b/man/bal_accuracy.Rd
diff --git a/man/brier_class.Rd b/man/brier_class.Rd
diff --git a/man/brier_survival.Rd b/man/brier_survival.Rd
diff --git a/man/brier_survival_integrated.Rd b/man/brier_survival_integrated.Rd
diff --git a/man/ccc.Rd b/man/ccc.Rd
diff --git a/man/classification_cost.Rd b/man/classification_cost.Rd
diff --git a/man/concordance_survival.Rd b/man/concordance_survival.Rd
diff --git a/man/conf_mat.Rd b/man/conf_mat.Rd
diff --git a/man/detection_prevalence.Rd b/man/detection_prevalence.Rd
diff --git a/man/f_meas.Rd b/man/f_meas.Rd
diff --git a/man/gain_capture.Rd b/man/gain_capture.Rd
diff --git a/man/gain_curve.Rd b/man/gain_curve.Rd
diff --git a/man/huber_loss.Rd b/man/huber_loss.Rd
diff --git a/man/huber_loss_pseudo.Rd b/man/huber_loss_pseudo.Rd
diff --git a/man/iic.Rd b/man/iic.Rd
diff --git a/man/j_index.Rd b/man/j_index.Rd
diff --git a/man/kap.Rd b/man/kap.Rd
diff --git a/man/lift_curve.Rd b/man/lift_curve.Rd
diff --git a/man/mae.Rd b/man/mae.Rd
diff --git a/man/mape.Rd b/man/mape.Rd
diff --git a/man/mase.Rd b/man/mase.Rd
diff --git a/man/mcc.Rd b/man/mcc.Rd
diff --git a/man/mn_log_loss.Rd b/man/mn_log_loss.Rd
diff --git a/man/mpe.Rd b/man/mpe.Rd
diff --git a/man/msd.Rd b/man/msd.Rd
diff --git a/man/npv.Rd b/man/npv.Rd
diff --git a/man/poisson_log_loss.Rd b/man/poisson_log_loss.Rd
diff --git a/man/ppv.Rd b/man/ppv.Rd
diff --git a/man/pr_auc.Rd b/man/pr_auc.Rd