R/param_stop_iter.R

In tidymodels/dials: Tools for Creating Tuning Parameter Values

#' Early stopping parameter
#'
#' For some models, the effectiveness of the model can decrease as training
#' iterations continue. `stop_iter()` can be used to tune how many iterations
#' without an improvement in the objective function occur before training should
#' be halted.
#'
#' @inheritParams Laplace
#' @examples
#' stop_iter()
#' @export
stop_iter <- function(range = c(3L, 20L), trans = NULL) {
  new_quant_param(
    type = "integer",
    range = range,
    inclusive = c(TRUE, TRUE),
    trans = trans,
    label = c(stop_iter = "# Iterations Before Stopping"),
    finalize = NULL
  )
}