Revision b57049d9ae4b73b8de7d012d648e7cca9a6478bc authored by pat-s on 22 January 2020, 12:41:32 UTC, committed by pat-s on 22 January 2020, 12:41:32 UTC
1 parent 141ae03
tuneThreshold.R
#' @title Tune prediction threshold.
#'
#' @description
#' Optimizes the threshold of predictions based on probabilities.
#' Works for classification and multilabel tasks.
#' Uses [BBmisc::optimizeSubInts] for normal binary class problems and
#' [GenSA::GenSA] for multiclass and multilabel problems.
#'
#' @template arg_pred
#' @param measure ([Measure])\cr
#' Performance measure to optimize.
#' Default is the default measure for the task.
#' @param task ([Task])\cr
#' Learning task. Rarely neeeded,
#' only when required for the performance measure.
#' @param model ([WrappedModel])\cr
#' Fitted model. Rarely neeeded,
#' only when required for the performance measure.
#' @param nsub (`integer(1)`)\cr
#' Passed to [BBmisc::optimizeSubInts] for 2class problems.
#' Default is 20.
#' @param control ([list])\cr
#' Control object for [GenSA::GenSA] when used.
#' Default is empty list.
#' @return ([list]). A named list with with the following components:
#' `th` is the optimal threshold, `perf` the performance value.
#' @family tune
#' @export
tuneThreshold = function(pred, measure, task, model, nsub = 20L, control = list()) {
checkPrediction(pred, task.type = c("classif", "multilabel"), predict.type = "prob")
td = pred$task.desc
ttype = td$type
measure = checkMeasures(measure, td)[[1L]]
if (!missing(task)) {
assertClass(task, classes = "SupervisedTask")
}
if (!missing(model)) {
assertClass(model, classes = "WrappedModel")
}
assertList(control)
probs = getPredictionProbabilities(pred)
# brutally return NA if we find any NA in the predicted probs...
if (anyMissing(probs)) {
return(list(th = NA, pred = pred, th.seq = numeric(0), perf = numeric(0)))
}
cls = pred$task.desc$class.levels
k = length(cls)
fitn = function(x) {
if (ttype == "multilabel" || k > 2) {
names(x) = cls
}
performance(setThreshold(pred, x), measure, task, model, simpleaggr = TRUE)
}
if (ttype == "multilabel" || k > 2L) {
requirePackages("GenSA", why = "tuneThreshold", default.method = "load")
start = rep(1 / k, k)
ctrl = list(smooth = FALSE, simple.function = TRUE, max.call = 3000L, temperature = 250,
visiting.param = 2.5, acceptance.param = -15)
or = GenSA::GenSA(par = start, fn = fitn, lower = rep(0, k),
upper = rep(1, k), control = ctrl)
th = or$par / sum(or$par)
names(th) = cls
perf = or$value
} else { # classif with k = 2
or = optimizeSubInts(f = fitn, lower = 0, upper = 1, maximum = !measure$minimize, nsub = nsub)
th = or[[1]]
perf = or$objective
}
return(list(th = th, perf = perf))
}
Computing file changes ...