From 9859f250feab417723727b20b5b681303633fe34 Mon Sep 17 00:00:00 2001 From: Sebastian Fischer Date: Sat, 21 Sep 2024 19:38:26 +0530 Subject: [PATCH 1/3] ... --- CRAN-SUBMISSION | 3 +++ DESCRIPTION | 4 ++-- NEWS.md | 4 ++++ R/PipeOpLearnerPred.R | 6 +++--- R/PipeOpMCBoost.R | 4 ++-- R/PipelineMCBoost.R | 2 +- README.md | 2 +- attic/PipeOpMCBoostSurv.R | 2 +- man-roxygen/params_data_label.R | 2 +- man-roxygen/params_data_resid.R | 2 +- man/AuditorFitter.Rd | 4 ++-- man/CVLearnerAuditorFitter.Rd | 2 +- man/LearnerAuditorFitter.Rd | 2 +- man/MCBoost.Rd | 2 +- man/SubgroupAuditorFitter.Rd | 2 +- man/SubpopAuditorFitter.Rd | 2 +- man/mlr_pipeops_mcboost.Rd | 10 +++++----- man/ppl_mcboost.Rd | 2 +- 18 files changed, 32 insertions(+), 25 deletions(-) create mode 100644 CRAN-SUBMISSION diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION new file mode 100644 index 0000000..ae2545b --- /dev/null +++ b/CRAN-SUBMISSION @@ -0,0 +1,3 @@ +Version: 0.4.4 +Date: 2024-09-12 09:48:16 UTC +SHA: 5c80fc18d839791a4ffe183b515d5f41c3de25cd diff --git a/DESCRIPTION b/DESCRIPTION index ecb2d05..10f13ba 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: mcboost Type: Package Title: Multi-Calibration Boosting -Version: 0.4.3-9000 +Version: 0.4.4 Authors@R: c(person(given = "Florian", family = "Pfisterer", @@ -69,7 +69,7 @@ Suggests: covr, testthat (>= 3.1.0) Roxygen: list(markdown = TRUE, r6 = TRUE) -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.2 VignetteBuilder: knitr Collate: 'AuditorFitters.R' diff --git a/NEWS.md b/NEWS.md index c1981a2..ed0c727 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,9 @@ # dev +# mcboost 0.4.4 + +* Fixed vignette in anticipation of new mlr3 release + # mcboost 0.4.3 * Compatibility with upcoming 'paradox' release. diff --git a/R/PipeOpLearnerPred.R b/R/PipeOpLearnerPred.R index 64f6cf6..7c70716 100644 --- a/R/PipeOpLearnerPred.R +++ b/R/PipeOpLearnerPred.R @@ -2,7 +2,7 @@ #' #' @usage NULL #' @name mlr_pipeops_mcboost -#' @format [`R6Class`] inheriting from [`mlr3pipelines::PipeOp`]. +#' @format [`R6Class`][R6::R6Class] inheriting from [`mlr3pipelines::PipeOp`]. #' #' @description #' [`mlr3pipelines::PipeOp`] that trains a [`Learner`][mlr3::Learner] and passes its predictions forward during training and prediction. @@ -43,7 +43,7 @@ #' Prediction time, in seconds. #' #' @section Fields: -#' Fields inherited from [`PipeOp`], as well as: +#' Fields inherited from [`PipeOp`][mlr3pipelines::PipeOp], as well as: #' * `learner` :: [`Learner`][mlr3::Learner]\cr #' [`Learner`][mlr3::Learner] that is being wrapped. Read-only. #' * `learner_model` :: [`Learner`][mlr3::Learner]\cr @@ -61,7 +61,7 @@ PipeOpLearnerPred = R6Class("PipeOpLearnerPred", #' @description #' Initialize a Learner Predictor PipeOp. Can be used to wrap trained or untrainted #' mlr3 learners. - #' @param learner [`Learner`]\cr + #' @param learner [`Learner`][mlr3::Learner]\cr #' The learner that should be wrapped. #' @param id [`character`] \cr #' The `PipeOp`'s id. Defaults to "mcboost". diff --git a/R/PipeOpMCBoost.R b/R/PipeOpMCBoost.R index 6ff5095..84a88b1 100644 --- a/R/PipeOpMCBoost.R +++ b/R/PipeOpMCBoost.R @@ -2,11 +2,11 @@ #' #' @usage NULL #' @name mlr_pipeops_mcboost -#' @format [`R6Class`] inheriting from [`mlr3pipelines::PipeOp`]. +#' @format [`R6Class`][R6::R6Class] inheriting from [`mlr3pipelines::PipeOp`]. #' #' @description #' Post-process a learner prediction using multi-calibration. -#' For more details, please refer to \url{https://arxiv.org/pdf/1805.12317.pdf} (Kim et al. 2018) +#' For more details, please refer to \url{http://arxiv.org/pdf/1805.12317.pdf} (Kim et al. 2018) #' or the help for [`MCBoost`]. #' If no `init_predictor` is provided, the preceding learner's predictions #' corresponding to the `prediction` slot are used as an initial predictor for `MCBoost`. diff --git a/R/PipelineMCBoost.R b/R/PipelineMCBoost.R index 3d14213..130fc05 100644 --- a/R/PipelineMCBoost.R +++ b/R/PipelineMCBoost.R @@ -11,7 +11,7 @@ #' Note: An initial predictor can also be supplied via the `init_predictor` parameter. #' @param param_vals `list` \cr #' List of parameter values passed on to `MCBoost$new`. -#' @return (mlr3pipelines) [`Graph`] +#' @return (mlr3pipelines) [`Graph`][mlr3pipelines::Graph] #' @examples #' \dontrun{ #' library("mlr3pipelines") diff --git a/README.md b/README.md index d819368..0bc3ac8 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ mc$predict_probs(test_data) ### Multi-Calibration -While `mcboost` in its defaults implements Multi-Accuracy ([Kim et al., 2019](https://arxiv.org/pdf/1805.12317.pdf)), +While `mcboost` in its defaults implements Multi-Accuracy ([Kim et al., 2019](http://arxiv.org/pdf/1805.12317.pdf)), it can also multi-calibrate predictors ([Hebert-Johnson et al., 2018](http://proceedings.mlr.press/v80/hebert-johnson18a.html)). In order to achieve this, we have to set the following hyperparameters: diff --git a/attic/PipeOpMCBoostSurv.R b/attic/PipeOpMCBoostSurv.R index 349920c..66f1cc9 100644 --- a/attic/PipeOpMCBoostSurv.R +++ b/attic/PipeOpMCBoostSurv.R @@ -162,7 +162,7 @@ PipeOpMCBoostSurv = R6Class("PipeOpMCBoostSurv", #' All parameters can be adjusted through the resulting Graph's `param_set`. #' @param param_vals `list` \cr #' List of parameter values passed on to `MCBoostSurv$new` -#' @return (mlr3pipelines) [`Graph`] +#' @return (mlr3pipelines) [`Graph`][mlr3pipelines::Graph] #' @examples #' library("mlr3pipelines") #' gr = ppl_mcboostsurv() diff --git a/man-roxygen/params_data_label.R b/man-roxygen/params_data_label.R index 888d9d4..1cf563c 100644 --- a/man-roxygen/params_data_label.R +++ b/man-roxygen/params_data_label.R @@ -1,4 +1,4 @@ -#' @param data [`data.table`]\cr +#' @param data [`data.table`][data.table::data.table]\cr #' Features. #' @param labels [`numeric`]\cr #' One-hot encoded labels (of same length as data). diff --git a/man-roxygen/params_data_resid.R b/man-roxygen/params_data_resid.R index c47743c..73fbc44 100644 --- a/man-roxygen/params_data_resid.R +++ b/man-roxygen/params_data_resid.R @@ -1,4 +1,4 @@ -#' @param data [`data.table`]\cr +#' @param data [`data.table`][data.table::data.table]\cr #' Features. #' @param resid [`numeric`]\cr #' Residuals (of same length as data). diff --git a/man/AuditorFitter.Rd b/man/AuditorFitter.Rd index df2be79..424e9fa 100644 --- a/man/AuditorFitter.Rd +++ b/man/AuditorFitter.Rd @@ -45,7 +45,7 @@ Fit to residuals. \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{data}}{\code{\link{data.table}}\cr +\item{\code{data}}{\code{\link[data.table:data.table]{data.table}}\cr Features.} \item{\code{resid}}{\code{\link{numeric}}\cr @@ -69,7 +69,7 @@ Fit (mostly used internally, use \code{fit_to_resid}). \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{data}}{\code{\link{data.table}}\cr +\item{\code{data}}{\code{\link[data.table:data.table]{data.table}}\cr Features.} \item{\code{resid}}{\code{\link{numeric}}\cr diff --git a/man/CVLearnerAuditorFitter.Rd b/man/CVLearnerAuditorFitter.Rd index 9c35a84..355a530 100644 --- a/man/CVLearnerAuditorFitter.Rd +++ b/man/CVLearnerAuditorFitter.Rd @@ -109,7 +109,7 @@ Fit the cross-validated learner and compute correlation \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{data}}{\code{\link{data.table}}\cr +\item{\code{data}}{\code{\link[data.table:data.table]{data.table}}\cr Features.} \item{\code{resid}}{\code{\link{numeric}}\cr diff --git a/man/LearnerAuditorFitter.Rd b/man/LearnerAuditorFitter.Rd index 41f8c45..2f0797e 100644 --- a/man/LearnerAuditorFitter.Rd +++ b/man/LearnerAuditorFitter.Rd @@ -100,7 +100,7 @@ Fit the learner and compute correlation \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{data}}{\code{\link{data.table}}\cr +\item{\code{data}}{\code{\link[data.table:data.table]{data.table}}\cr Features.} \item{\code{resid}}{\code{\link{numeric}}\cr diff --git a/man/MCBoost.Rd b/man/MCBoost.Rd index 646f287..3cfd3fa 100644 --- a/man/MCBoost.Rd +++ b/man/MCBoost.Rd @@ -222,7 +222,7 @@ Run multi-calibration. \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{data}}{\code{\link{data.table}}\cr +\item{\code{data}}{\code{\link[data.table:data.table]{data.table}}\cr Features.} \item{\code{labels}}{\code{\link{numeric}}\cr diff --git a/man/SubgroupAuditorFitter.Rd b/man/SubgroupAuditorFitter.Rd index 44bd5b4..a3ba30b 100644 --- a/man/SubgroupAuditorFitter.Rd +++ b/man/SubgroupAuditorFitter.Rd @@ -100,7 +100,7 @@ Fit the learner and compute correlation \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{data}}{\code{\link{data.table}}\cr +\item{\code{data}}{\code{\link[data.table:data.table]{data.table}}\cr Features.} \item{\code{resid}}{\code{\link{numeric}}\cr diff --git a/man/SubpopAuditorFitter.Rd b/man/SubpopAuditorFitter.Rd index ecfb31d..19a5ed6 100644 --- a/man/SubpopAuditorFitter.Rd +++ b/man/SubpopAuditorFitter.Rd @@ -100,7 +100,7 @@ Fit the learner and compute correlation \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{data}}{\code{\link{data.table}}\cr +\item{\code{data}}{\code{\link[data.table:data.table]{data.table}}\cr Features.} \item{\code{resid}}{\code{\link{numeric}}\cr diff --git a/man/mlr_pipeops_mcboost.Rd b/man/mlr_pipeops_mcboost.Rd index 21ef9f7..4f67c45 100644 --- a/man/mlr_pipeops_mcboost.Rd +++ b/man/mlr_pipeops_mcboost.Rd @@ -6,15 +6,15 @@ \alias{PipeOpMCBoost} \title{Multi-Calibrate a Learner's Prediction} \format{ -\code{\link{R6Class}} inheriting from \code{\link[mlr3pipelines:PipeOp]{mlr3pipelines::PipeOp}}. +\code{\link[R6:R6Class]{R6Class}} inheriting from \code{\link[mlr3pipelines:PipeOp]{mlr3pipelines::PipeOp}}. -\code{\link{R6Class}} inheriting from \code{\link[mlr3pipelines:PipeOp]{mlr3pipelines::PipeOp}}. +\code{\link[R6:R6Class]{R6Class}} inheriting from \code{\link[mlr3pipelines:PipeOp]{mlr3pipelines::PipeOp}}. } \description{ \code{\link[mlr3pipelines:PipeOp]{mlr3pipelines::PipeOp}} that trains a \code{\link[mlr3:Learner]{Learner}} and passes its predictions forward during training and prediction. Post-process a learner prediction using multi-calibration. -For more details, please refer to \url{https://arxiv.org/pdf/1805.12317.pdf} (Kim et al. 2018) +For more details, please refer to \url{http://arxiv.org/pdf/1805.12317.pdf} (Kim et al. 2018) or the help for \code{\link{MCBoost}}. If no \code{init_predictor} is provided, the preceding learner's predictions corresponding to the \code{prediction} slot are used as an initial predictor for \code{MCBoost}. @@ -100,7 +100,7 @@ A integer specifying the number of multi-calibration rounds. Defaults to 5. \section{Fields}{ -Fields inherited from \code{\link{PipeOp}}, as well as: +Fields inherited from \code{\link[mlr3pipelines:PipeOp]{PipeOp}}, as well as: \itemize{ \item \code{learner} :: \code{\link[mlr3:Learner]{Learner}}\cr \code{\link[mlr3:Learner]{Learner}} that is being wrapped. Read-only. @@ -181,7 +181,7 @@ mlr3 learners. \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{learner}}{\code{\link{Learner}}\cr +\item{\code{learner}}{\code{\link[mlr3:Learner]{Learner}}\cr The learner that should be wrapped.} \item{\code{id}}{\code{\link{character}} \cr diff --git a/man/ppl_mcboost.Rd b/man/ppl_mcboost.Rd index 71fd8fe..3b1346e 100644 --- a/man/ppl_mcboost.Rd +++ b/man/ppl_mcboost.Rd @@ -18,7 +18,7 @@ Note: An initial predictor can also be supplied via the \code{init_predictor} pa List of parameter values passed on to \code{MCBoost$new}.} } \value{ -(mlr3pipelines) \code{\link{Graph}} +(mlr3pipelines) \code{\link[mlr3pipelines:Graph]{Graph}} } \description{ Wraps MCBoost in a Pipeline to be used with \code{mlr3pipelines}. From da2d484943d35309220a0e3b3849fd0f9f491c2a Mon Sep 17 00:00:00 2001 From: Sebastian Fischer Date: Wed, 23 Jul 2025 09:58:00 +0200 Subject: [PATCH 2/3] fix anchors --- .gitignore | 1 + CRAN-SUBMISSION | 4 ++-- NEWS.md | 2 +- R/MCBoost.R | 5 ++--- R/PipeOpLearnerPred.R | 4 ++-- R/Predictor.R | 14 +++++++------- attic/PipeOpMCBoostSurv.R | 4 ++-- cran-comments.md | 18 ++++++++++++++---- man/MCBoost.Rd | 4 ++-- man/mlr_pipeops_mcboost.Rd | 4 ++-- 10 files changed, 35 insertions(+), 25 deletions(-) diff --git a/.gitignore b/.gitignore index bab7905..663f334 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,5 @@ test/testthat/snaps docs/ docs /doc/ +.DS_Store /Meta/ diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION index ae2545b..0c24b9c 100644 --- a/CRAN-SUBMISSION +++ b/CRAN-SUBMISSION @@ -1,3 +1,3 @@ Version: 0.4.4 -Date: 2024-09-12 09:48:16 UTC -SHA: 5c80fc18d839791a4ffe183b515d5f41c3de25cd +Date: 2025-07-23 07:55:15 UTC +SHA: 9859f250feab417723727b20b5b681303633fe34 diff --git a/NEWS.md b/NEWS.md index ed0c727..6668891 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,7 +2,7 @@ # mcboost 0.4.4 -* Fixed vignette in anticipation of new mlr3 release +* Fix link anchors # mcboost 0.4.3 diff --git a/R/MCBoost.R b/R/MCBoost.R index 4d9eaf7..81d9ad4 100644 --- a/R/MCBoost.R +++ b/R/MCBoost.R @@ -219,7 +219,6 @@ MCBoost = R6::R6Class("MCBoost", labels = private$assert_labels(labels, ...) pred_probs = private$assert_prob(do.call(self$predictor, discard(list(data, predictor_args), is.null)), data, ...) buckets = private$create_buckets(pred_probs) - # Compute residuals and multiply with weighting for low-degree MC. resid = private$compute_residuals(pred_probs, labels) weighted_preds = private$compute_weighted_preds(pred_probs) @@ -285,7 +284,7 @@ MCBoost = R6::R6Class("MCBoost", }, #' @description #' Predict a dataset with multi-calibrated predictions - #' @param x [`data.table`] \cr + #' @param x [`data.table`][data.table::data.table] \cr #' Prediction data. #' @param t [`integer`] \cr #' Number of multi-calibration steps to predict. Default: `Inf` (all). @@ -320,7 +319,7 @@ MCBoost = R6::R6Class("MCBoost", #' Compute the auditor effect for each instance which are the cumulative #' absolute predictions of the auditor. It indicates "how much" #' each observation was affected by multi-calibration on average across iterations. - #' @param x [`data.table`] \cr + #' @param x [`data.table`][data.table::data.table] \cr #' Prediction data. #' @param aggregate [`logical`] \cr #' Should the auditor effect be aggregated across iterations? Defaults to `TRUE`. diff --git a/R/PipeOpLearnerPred.R b/R/PipeOpLearnerPred.R index 7c70716..7d73857 100644 --- a/R/PipeOpLearnerPred.R +++ b/R/PipeOpLearnerPred.R @@ -33,11 +33,11 @@ #' [`mlr3pipelines::PipeOpTaskPreproc`]. It is a named `list` with the inherited members, as well as: #' * `model` :: `any`\cr #' Model created by the [`Learner`][mlr3::Learner]'s `$.train()` function. -#' * `train_log` :: [`data.table`] with columns `class` (`character`), `msg` (`character`)\cr +#' * `train_log` :: [`data.table`][data.table::data.table] with columns `class` (`character`), `msg` (`character`)\cr #' Errors logged during training. #' * `train_time` :: `numeric(1)`\cr #' Training time, in seconds. -#' * `predict_log` :: `NULL` | [`data.table`] with columns `class` (`character`), `msg` (`character`)\cr +#' * `predict_log` :: `NULL` | [`data.table`][data.table::data.table] with columns `class` (`character`), `msg` (`character`)\cr #' Errors logged during prediction. #' * `predict_time` :: `NULL` | `numeric(1)` #' Prediction time, in seconds. diff --git a/R/Predictor.R b/R/Predictor.R index 0f75855..92d8ba4 100644 --- a/R/Predictor.R +++ b/R/Predictor.R @@ -16,8 +16,8 @@ Predictor = R6::R6Class("Predictor", }, #' @description #' Predict a dataset with constant predictions. - #' @param data [`data.table`] \cr - #' Prediction data. + #' @param data [`data.table`][data.table::data.table] \cr + #r Prediction data. #' @param ... [`any`] \cr #' Not used, only for compatibility with other methods. predict = function(data, ...) { @@ -56,7 +56,7 @@ ConstantPredictor = R6::R6Class("ConstantPredictor", }, #' @description #' Predict a dataset with constant predictions. - #' @param data [`data.table`] \cr + #' @param data [`data.table`][data.table::data.table] \cr #' Prediction data. #' @param ... [`any`] \cr #' Not used, only for compatibility with other methods. @@ -95,7 +95,7 @@ LearnerPredictor = R6::R6Class("LearnerPredictor", }, #' @description #' Predict a dataset with leaner predictions. - #' @param data [`data.table`] \cr + #' @param data [`data.table`][data.table::data.table] \cr #' Prediction data. #' @param ... [`any`] \cr #' Not used, only for compatibility with other methods. @@ -169,7 +169,7 @@ SubpopPredictor = R6::R6Class("SubpopPredictor", }, #' @description #' Predict a dataset with sub-population predictions. - #' @param data [`data.table`] \cr + #' @param data [`data.table`][data.table::data.table] \cr #' Prediction data. #' @param ... [`any`] \cr #' Not used, only for compatibility with other methods. @@ -211,7 +211,7 @@ SubgroupModel = R6::R6Class("SubgroupModel", }, #' @description #' Predict a dataset with sub-population predictions. - #' @param data [`data.table`] \cr + #' @param data [`data.table`][data.table::data.table] \cr #' Prediction data. #' @param subgroup_masks [`list`] \cr #' List of subgroup masks for the data. @@ -274,7 +274,7 @@ CVLearnerPredictor = R6::R6Class("CVLearnerPredictor", }, #' @description #' Predict a dataset with leaner predictions. - #' @param data [`data.table`] \cr + #' @param data [`data.table`][data.table::data.table] \cr #' Prediction data. #' @param ... [`any`] \cr #' Not used, only for compatibility with other methods. diff --git a/attic/PipeOpMCBoostSurv.R b/attic/PipeOpMCBoostSurv.R index 66f1cc9..50eea63 100644 --- a/attic/PipeOpMCBoostSurv.R +++ b/attic/PipeOpMCBoostSurv.R @@ -2,7 +2,7 @@ #' #' @usage NULL #' @name mlr_pipeops_mcboostsurv -#' @format [`R6Class`] inheriting from [`mlr3pipelines::PipeOp`]. +#' @format [`R6Class`][R6::R6Class] inheriting from [`PipeOp`][mlr3pipelines::PipeOp]. #' #' @description #' Post-process a survival learner prediction using multi-calibration. @@ -87,7 +87,7 @@ PipeOpMCBoostSurv = R6Class("PipeOpMCBoostSurv", super$initialize(id, param_set = param_set, param_vals = param_vals, packages = c("mlr3proba", "survival"), input = data.table( - name = c("data", "prediction"), + name = c("data", "prediction"), train = c("TaskSurv", "TaskSurv"), predict = c("TaskSurv", "TaskSurv") ), diff --git a/cran-comments.md b/cran-comments.md index 671045a..d6226f2 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,6 +1,16 @@ -## R CMD check +# R CMD CHECK Results -0 errors | 0 warnings | 1 note +1 Note, but the url is valid. -New maintainer: - Sebastian Fischer +Found the following (possibly) invalid URLs: + URL: http://arxiv.org/pdf/1805.12317.pdf (moved to http://arxiv.org/pdf/1805.12317) + From: man/mlr_pipeops_mcboost.Rd + README.md + Status: 301 + Message: Moved Permanently + URL: https://arxiv.org/pdf/1805.12317.pdf (moved to http://arxiv.org/pdf/1805.12317) + From: README.md + Status: 301 + Message: Moved Permanently +For content that is 'Moved Permanently', please change http to https, +add trailing slashes, or replace the old by the new URL. diff --git a/man/MCBoost.Rd b/man/MCBoost.Rd index 3cfd3fa..696f980 100644 --- a/man/MCBoost.Rd +++ b/man/MCBoost.Rd @@ -255,7 +255,7 @@ Predict a dataset with multi-calibrated predictions \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{x}}{\code{\link{data.table}} \cr +\item{\code{x}}{\code{\link[data.table:data.table]{data.table}} \cr Prediction data.} \item{\code{t}}{\code{\link{integer}} \cr @@ -297,7 +297,7 @@ each observation was affected by multi-calibration on average across iterations. \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{x}}{\code{\link{data.table}} \cr +\item{\code{x}}{\code{\link[data.table:data.table]{data.table}} \cr Prediction data.} \item{\code{aggregate}}{\code{\link{logical}} \cr diff --git a/man/mlr_pipeops_mcboost.Rd b/man/mlr_pipeops_mcboost.Rd index 4f67c45..ef427f4 100644 --- a/man/mlr_pipeops_mcboost.Rd +++ b/man/mlr_pipeops_mcboost.Rd @@ -81,11 +81,11 @@ The \verb{$state} is set to the \verb{$state} slot of the \code{\link[mlr3:Learn \itemize{ \item \code{model} :: \code{any}\cr Model created by the \code{\link[mlr3:Learner]{Learner}}'s \verb{$.train()} function. -\item \code{train_log} :: \code{\link{data.table}} with columns \code{class} (\code{character}), \code{msg} (\code{character})\cr +\item \code{train_log} :: \code{\link[data.table:data.table]{data.table}} with columns \code{class} (\code{character}), \code{msg} (\code{character})\cr Errors logged during training. \item \code{train_time} :: \code{numeric(1)}\cr Training time, in seconds. -\item \code{predict_log} :: \code{NULL} | \code{\link{data.table}} with columns \code{class} (\code{character}), \code{msg} (\code{character})\cr +\item \code{predict_log} :: \code{NULL} | \code{\link[data.table:data.table]{data.table}} with columns \code{class} (\code{character}), \code{msg} (\code{character})\cr Errors logged during prediction. \item \code{predict_time} :: \code{NULL} | \code{numeric(1)} Prediction time, in seconds. From 594f8fd432df9fb275a53045396f52b51c0beb59 Mon Sep 17 00:00:00 2001 From: Sebastian Fischer Date: Thu, 24 Jul 2025 10:19:04 +0200 Subject: [PATCH 3/3] release 0.4.4 --- .gitignore | 1 + CRAN-SUBMISSION | 3 --- R/PipeOpMCBoost.R | 2 +- README.md | 6 +++--- attic/PipeOpMCBoostSurv.R | 2 +- cran-comments.md | 14 -------------- man/mlr_pipeops_mcboost.Rd | 2 +- 7 files changed, 7 insertions(+), 23 deletions(-) delete mode 100644 CRAN-SUBMISSION diff --git a/.gitignore b/.gitignore index 663f334..102ef35 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ docs /doc/ .DS_Store /Meta/ +CRAN-SUBMISSION diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION deleted file mode 100644 index 0c24b9c..0000000 --- a/CRAN-SUBMISSION +++ /dev/null @@ -1,3 +0,0 @@ -Version: 0.4.4 -Date: 2025-07-23 07:55:15 UTC -SHA: 9859f250feab417723727b20b5b681303633fe34 diff --git a/R/PipeOpMCBoost.R b/R/PipeOpMCBoost.R index 84a88b1..b111d3e 100644 --- a/R/PipeOpMCBoost.R +++ b/R/PipeOpMCBoost.R @@ -6,7 +6,7 @@ #' #' @description #' Post-process a learner prediction using multi-calibration. -#' For more details, please refer to \url{http://arxiv.org/pdf/1805.12317.pdf} (Kim et al. 2018) +#' For more details, please refer to \url{http://arxiv.org/pdf/1805.12317} (Kim et al. 2018) #' or the help for [`MCBoost`]. #' If no `init_predictor` is provided, the preceding learner's predictions #' corresponding to the `prediction` slot are used as an initial predictor for `MCBoost`. diff --git a/README.md b/README.md index 0bc3ac8..c020bbd 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ ## What does it do? -**mcboost** implements Multi-Calibration Boosting ([Hebert-Johnson et al., 2018](https://proceedings.mlr.press/v80/hebert-johnson18a.html); [Kim et al., 2019](https://arxiv.org/pdf/1805.12317.pdf)) for the multi-calibration of a machine learning model's prediction. Multi-Calibration works best in scenarios where the underlying data & labels are unbiased but a bias is introduced within the algorithm's fitting procedure. This is often the case, e.g. when an algorithm fits a majority population while ignoring or under-fitting minority populations. +**mcboost** implements Multi-Calibration Boosting ([Hebert-Johnson et al., 2018](https://proceedings.mlr.press/v80/hebert-johnson18a.html); [Kim et al., 2019](https://arxiv.org/pdf/1805.12317)) for the multi-calibration of a machine learning model's prediction. Multi-Calibration works best in scenarios where the underlying data & labels are unbiased but a bias is introduced within the algorithm's fitting procedure. This is often the case, e.g. when an algorithm fits a majority population while ignoring or under-fitting minority populations. For more information and example, see the package's [website](https://mlr-org.github.io/mcboost/). @@ -99,7 +99,7 @@ mc$predict_probs(test_data) ### Multi-Calibration -While `mcboost` in its defaults implements Multi-Accuracy ([Kim et al., 2019](http://arxiv.org/pdf/1805.12317.pdf)), +While `mcboost` in its defaults implements Multi-Accuracy ([Kim et al., 2019](http://arxiv.org/pdf/1805.12317)), it can also multi-calibrate predictors ([Hebert-Johnson et al., 2018](http://proceedings.mlr.press/v80/hebert-johnson18a.html)). In order to achieve this, we have to set the following hyperparameters: @@ -152,7 +152,7 @@ If you use `mcboost`, please cite our package as well as the two papers it is ba ``` @article{pfisterer2021, - author = {Pfisterer, Florian and Kern, Christoph and Dandl, Susanne and Sun, Matthew and + author = {Pfisterer, Florian and Kern, Christoph and Dandl, Susanne and Sun, Matthew and Kim, Michael P. and Bischl, Bernd}, title = {mcboost: Multi-Calibration Boosting for R}, journal = {Journal of Open Source Software}, diff --git a/attic/PipeOpMCBoostSurv.R b/attic/PipeOpMCBoostSurv.R index 50eea63..4561545 100644 --- a/attic/PipeOpMCBoostSurv.R +++ b/attic/PipeOpMCBoostSurv.R @@ -6,7 +6,7 @@ #' #' @description #' Post-process a survival learner prediction using multi-calibration. -#' For more details, please refer to \url{https://arxiv.org/pdf/1805.12317.pdf} (Kim et al. 2018) +#' For more details, please refer to \url{https://arxiv.org/pdf/1805.12317} (Kim et al. 2018) #' or the help for [`MCBoostSurv`]. #' If no `init_predictor` is provided, the preceding learner's predictions #' corresponding to the `prediction` slot are used as an initial predictor for `MCBoostSurv`. diff --git a/cran-comments.md b/cran-comments.md index d6226f2..95e3abc 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,16 +1,2 @@ # R CMD CHECK Results -1 Note, but the url is valid. - -Found the following (possibly) invalid URLs: - URL: http://arxiv.org/pdf/1805.12317.pdf (moved to http://arxiv.org/pdf/1805.12317) - From: man/mlr_pipeops_mcboost.Rd - README.md - Status: 301 - Message: Moved Permanently - URL: https://arxiv.org/pdf/1805.12317.pdf (moved to http://arxiv.org/pdf/1805.12317) - From: README.md - Status: 301 - Message: Moved Permanently -For content that is 'Moved Permanently', please change http to https, -add trailing slashes, or replace the old by the new URL. diff --git a/man/mlr_pipeops_mcboost.Rd b/man/mlr_pipeops_mcboost.Rd index ef427f4..5652617 100644 --- a/man/mlr_pipeops_mcboost.Rd +++ b/man/mlr_pipeops_mcboost.Rd @@ -14,7 +14,7 @@ \code{\link[mlr3pipelines:PipeOp]{mlr3pipelines::PipeOp}} that trains a \code{\link[mlr3:Learner]{Learner}} and passes its predictions forward during training and prediction. Post-process a learner prediction using multi-calibration. -For more details, please refer to \url{http://arxiv.org/pdf/1805.12317.pdf} (Kim et al. 2018) +For more details, please refer to \url{http://arxiv.org/pdf/1805.12317} (Kim et al. 2018) or the help for \code{\link{MCBoost}}. If no \code{init_predictor} is provided, the preceding learner's predictions corresponding to the \code{prediction} slot are used as an initial predictor for \code{MCBoost}.