diff --git a/R/AutoFSelector.R b/R/AutoFSelector.R index abe2e78d..538f5059 100644 --- a/R/AutoFSelector.R +++ b/R/AutoFSelector.R @@ -161,7 +161,7 @@ AutoFSelector = R6Class("AutoFSelector", #' @param recursive (`integer(1)`)\cr #' Depth of recursion for multiple nested objects. #' - #' @return [Learner]. + #' @return [mlr3::Learner]. base_learner = function(recursive = Inf) { if (recursive == 0L) self$learner else self$learner$base_learner(recursive - 1L) }, diff --git a/R/CallbackBatchFSelect.R b/R/CallbackBatchFSelect.R index b81a355e..fe9f3a7a 100644 --- a/R/CallbackBatchFSelect.R +++ b/R/CallbackBatchFSelect.R @@ -76,7 +76,7 @@ CallbackBatchFSelect = R6Class("CallbackBatchFSelect", #' This context can be used to customize the evaluation of a batch of feature sets. #' Changes to the state of callback are lost after the evaluation of a batch and changes to the fselect instance or the fselector are not possible. #' Persistent data should be written to the archive via `$aggregated_performance` (see [ContextBatchFSelect]). -#' The other stages access [ContextBatch]. +#' The other stages access [bbotk::ContextBatch]. #' This context can be used to modify the fselect instance, archive, fselector and final result. #' There are two different contexts because the evaluation can be parallelized i.e. multiple instances of [ContextBatchFSelect] exists on different workers at the same time. #' diff --git a/R/ensemble_fselect.R b/R/ensemble_fselect.R index 940dc2f5..ed1aceb3 100644 --- a/R/ensemble_fselect.R +++ b/R/ensemble_fselect.R @@ -20,7 +20,7 @@ #' @param init_resampling ([mlr3::Resampling])\cr #' The initial resampling strategy of the data, from which each train set #' will be passed on to the learners. -#' Can only be [mlr_resamplings_subsampling] or [mlr_resamplings_bootstrap]. +#' Can only be [mlr3::ResamplingSubsampling] or [mlr3::ResamplingBootstrap]. #' @param inner_resampling ([mlr3::Resampling])\cr #' The inner resampling strategy used by the [FSelector]. #' @param store_benchmark_result (`logical(1)`)\cr diff --git a/R/fselect.R b/R/fselect.R index 7b0f85a6..e374ea36 100644 --- a/R/fselect.R +++ b/R/fselect.R @@ -9,11 +9,11 @@ #' The [ArchiveBatchFSelect] (`$archive`) stores all evaluated hyperparameter configurations and performance scores. #' #' @details -#' The [mlr3::Task], [mlr3::Learner], [mlr3::Resampling], [mlr3::Measure] and [Terminator] are used to construct a [FSelectInstanceBatchSingleCrit]. -#' If multiple performance [Measures][Measure] are supplied, a [FSelectInstanceBatchMultiCrit] is created. -#' The parameter `term_evals` and `term_time` are shortcuts to create a [Terminator]. -#' If both parameters are passed, a [TerminatorCombo] is constructed. -#' For other [Terminators][Terminator], pass one with `terminator`. +#' The [mlr3::Task], [mlr3::Learner], [mlr3::Resampling], [mlr3::Measure] and [bbotk::Terminator] are used to construct a [FSelectInstanceBatchSingleCrit]. +#' If multiple performance [Measures][mlr3::Measure] are supplied, a [FSelectInstanceBatchMultiCrit] is created. +#' The parameter `term_evals` and `term_time` are shortcuts to create a [bbotk::Terminator]. +#' If both parameters are passed, a [bbotk::TerminatorCombo] is constructed. +#' For other [Terminators][bbotk::Terminator], pass one with `terminator`. #' If no termination criterion is needed, set `term_evals`, `term_time` and `terminator` to `NULL`. #' #' @inheritSection FSelectInstanceBatchSingleCrit Resources diff --git a/R/sugar.R b/R/sugar.R index c1f97c00..7608615e 100644 --- a/R/sugar.R +++ b/R/sugar.R @@ -6,8 +6,8 @@ #' #' * `fs()` for a [FSelector] from [mlr_fselectors]. #' * `fss()` for a list of a [FSelector] from [mlr_fselectors]. -#' * `trm()` for a [Terminator] from [mlr_terminators]. -#' * `trms()` for a list of [Terminators][Terminator] from [mlr_terminators]. +#' * `trm()` for a [bbotk::Terminator] from [mlr_terminators]. +#' * `trms()` for a list of [Terminators][bbotk::Terminator] from [mlr_terminators]. #' #' @inheritParams mlr3::mlr_sugar #' @return [R6::R6Class] object of the respective type, or a list of [R6::R6Class] objects for the plural versions. diff --git a/man-roxygen/param_terminator.R b/man-roxygen/param_terminator.R index 66f298f1..5ac4014a 100644 --- a/man-roxygen/param_terminator.R +++ b/man-roxygen/param_terminator.R @@ -1,2 +1,2 @@ -#' @param terminator ([Terminator])\cr +#' @param terminator ([bbotk::Terminator])\cr #' Stop criterion of the feature selection. diff --git a/man/AutoFSelector.Rd b/man/AutoFSelector.Rd index 383a14ee..9c59c626 100644 --- a/man/AutoFSelector.Rd +++ b/man/AutoFSelector.Rd @@ -196,7 +196,7 @@ Already instantiated resamplings are kept unchanged.} \item{\code{measure}}{(\link[mlr3:Measure]{mlr3::Measure})\cr Measure to optimize. If \code{NULL}, default measure is used.} -\item{\code{terminator}}{(\link{Terminator})\cr +\item{\code{terminator}}{(\link[bbotk:Terminator]{bbotk::Terminator})\cr Stop criterion of the feature selection.} \item{\code{store_fselect_instance}}{(\code{logical(1)})\cr @@ -246,7 +246,7 @@ Depth of recursion for multiple nested objects.} \if{html}{\out{}} } \subsection{Returns}{ -\link{Learner}. +\link[mlr3:Learner]{mlr3::Learner}. } } \if{html}{\out{
}} diff --git a/man/FSelectInstanceBatchMultiCrit.Rd b/man/FSelectInstanceBatchMultiCrit.Rd index 7668f6d3..82b136df 100644 --- a/man/FSelectInstanceBatchMultiCrit.Rd +++ b/man/FSelectInstanceBatchMultiCrit.Rd @@ -125,7 +125,7 @@ Already instantiated resamplings are kept unchanged.} Measures to optimize. If \code{NULL}, \CRANpkg{mlr3}'s default measure is used.} -\item{\code{terminator}}{(\link{Terminator})\cr +\item{\code{terminator}}{(\link[bbotk:Terminator]{bbotk::Terminator})\cr Stop criterion of the feature selection.} \item{\code{store_benchmark_result}}{(\code{logical(1)})\cr diff --git a/man/FSelectInstanceBatchSingleCrit.Rd b/man/FSelectInstanceBatchSingleCrit.Rd index e745ceb2..fa905387 100644 --- a/man/FSelectInstanceBatchSingleCrit.Rd +++ b/man/FSelectInstanceBatchSingleCrit.Rd @@ -159,7 +159,7 @@ Already instantiated resamplings are kept unchanged.} \item{\code{measure}}{(\link[mlr3:Measure]{mlr3::Measure})\cr Measure to optimize. If \code{NULL}, default measure is used.} -\item{\code{terminator}}{(\link{Terminator})\cr +\item{\code{terminator}}{(\link[bbotk:Terminator]{bbotk::Terminator})\cr Stop criterion of the feature selection.} \item{\code{store_benchmark_result}}{(\code{logical(1)})\cr diff --git a/man/auto_fselector.Rd b/man/auto_fselector.Rd index 2ecdb421..55d4183c 100644 --- a/man/auto_fselector.Rd +++ b/man/auto_fselector.Rd @@ -43,7 +43,7 @@ Ignored if \code{terminator} is passed.} Maximum allowed time in seconds. Ignored if \code{terminator} is passed.} -\item{terminator}{(\link{Terminator})\cr +\item{terminator}{(\link[bbotk:Terminator]{bbotk::Terminator})\cr Stop criterion of the feature selection.} \item{store_fselect_instance}{(\code{logical(1)})\cr diff --git a/man/callback_batch_fselect.Rd b/man/callback_batch_fselect.Rd index 33e9794e..6e6d7527 100644 --- a/man/callback_batch_fselect.Rd +++ b/man/callback_batch_fselect.Rd @@ -99,7 +99,7 @@ The stages \code{on_eval_after_design}, \code{on_eval_after_benchmark}, \code{on This context can be used to customize the evaluation of a batch of feature sets. Changes to the state of callback are lost after the evaluation of a batch and changes to the fselect instance or the fselector are not possible. Persistent data should be written to the archive via \verb{$aggregated_performance} (see \link{ContextBatchFSelect}). -The other stages access \link{ContextBatch}. +The other stages access \link[bbotk:ContextBatch]{bbotk::ContextBatch}. This context can be used to modify the fselect instance, archive, fselector and final result. There are two different contexts because the evaluation can be parallelized i.e. multiple instances of \link{ContextBatchFSelect} exists on different workers at the same time. } diff --git a/man/ensemble_fselect.Rd b/man/ensemble_fselect.Rd index 6a8454f1..c83a22e4 100644 --- a/man/ensemble_fselect.Rd +++ b/man/ensemble_fselect.Rd @@ -46,7 +46,7 @@ The learners to be used for feature selection.} \item{init_resampling}{(\link[mlr3:Resampling]{mlr3::Resampling})\cr The initial resampling strategy of the data, from which each train set will be passed on to the learners. -Can only be \link{mlr_resamplings_subsampling} or \link{mlr_resamplings_bootstrap}.} +Can only be \link[mlr3:mlr_resamplings_subsampling]{mlr3::ResamplingSubsampling} or \link[mlr3:mlr_resamplings_bootstrap]{mlr3::ResamplingBootstrap}.} \item{inner_resampling}{(\link[mlr3:Resampling]{mlr3::Resampling})\cr The inner resampling strategy used by the \link{FSelector}.} @@ -54,7 +54,7 @@ The inner resampling strategy used by the \link{FSelector}.} \item{measure}{(\link[mlr3:Measure]{mlr3::Measure})\cr Measure to optimize. If \code{NULL}, default measure is used.} -\item{terminator}{(\link{Terminator})\cr +\item{terminator}{(\link[bbotk:Terminator]{bbotk::Terminator})\cr Stop criterion of the feature selection.} \item{callbacks}{(list of lists of \link{CallbackBatchFSelect})\cr diff --git a/man/fs.Rd b/man/fs.Rd index ea2c2bae..f0253479 100644 --- a/man/fs.Rd +++ b/man/fs.Rd @@ -28,8 +28,8 @@ Relies on \code{\link[mlr3misc:dictionary_sugar_get]{mlr3misc::dictionary_sugar_ \itemize{ \item \code{fs()} for a \link{FSelector} from \link{mlr_fselectors}. \item \code{fss()} for a list of a \link{FSelector} from \link{mlr_fselectors}. -\item \code{trm()} for a \link{Terminator} from \link{mlr_terminators}. -\item \code{trms()} for a list of \link[=Terminator]{Terminators} from \link{mlr_terminators}. +\item \code{trm()} for a \link[bbotk:Terminator]{bbotk::Terminator} from \link{mlr_terminators}. +\item \code{trms()} for a list of \link[bbotk:Terminator]{Terminators} from \link{mlr_terminators}. } } \examples{ diff --git a/man/fselect.Rd b/man/fselect.Rd index cbe19b8f..841f9c07 100644 --- a/man/fselect.Rd +++ b/man/fselect.Rd @@ -47,7 +47,7 @@ Ignored if \code{terminator} is passed.} Maximum allowed time in seconds. Ignored if \code{terminator} is passed.} -\item{terminator}{(\link{Terminator})\cr +\item{terminator}{(\link[bbotk:Terminator]{bbotk::Terminator})\cr Stop criterion of the feature selection.} \item{store_benchmark_result}{(\code{logical(1)})\cr @@ -81,11 +81,11 @@ It executes the feature selection with the \link{FSelector} (\code{method}) and The \link{ArchiveBatchFSelect} (\verb{$archive}) stores all evaluated hyperparameter configurations and performance scores. } \details{ -The \link[mlr3:Task]{mlr3::Task}, \link[mlr3:Learner]{mlr3::Learner}, \link[mlr3:Resampling]{mlr3::Resampling}, \link[mlr3:Measure]{mlr3::Measure} and \link{Terminator} are used to construct a \link{FSelectInstanceBatchSingleCrit}. -If multiple performance \link[=Measure]{Measures} are supplied, a \link{FSelectInstanceBatchMultiCrit} is created. -The parameter \code{term_evals} and \code{term_time} are shortcuts to create a \link{Terminator}. -If both parameters are passed, a \link{TerminatorCombo} is constructed. -For other \link[=Terminator]{Terminators}, pass one with \code{terminator}. +The \link[mlr3:Task]{mlr3::Task}, \link[mlr3:Learner]{mlr3::Learner}, \link[mlr3:Resampling]{mlr3::Resampling}, \link[mlr3:Measure]{mlr3::Measure} and \link[bbotk:Terminator]{bbotk::Terminator} are used to construct a \link{FSelectInstanceBatchSingleCrit}. +If multiple performance \link[mlr3:Measure]{Measures} are supplied, a \link{FSelectInstanceBatchMultiCrit} is created. +The parameter \code{term_evals} and \code{term_time} are shortcuts to create a \link[bbotk:Terminator]{bbotk::Terminator}. +If both parameters are passed, a \link[bbotk:mlr_terminators_combo]{bbotk::TerminatorCombo} is constructed. +For other \link[bbotk:Terminator]{Terminators}, pass one with \code{terminator}. If no termination criterion is needed, set \code{term_evals}, \code{term_time} and \code{terminator} to \code{NULL}. } \section{Resources}{ diff --git a/man/fselect_nested.Rd b/man/fselect_nested.Rd index ed04cfdb..5c0f9899 100644 --- a/man/fselect_nested.Rd +++ b/man/fselect_nested.Rd @@ -49,7 +49,7 @@ Ignored if \code{terminator} is passed.} Maximum allowed time in seconds. Ignored if \code{terminator} is passed.} -\item{terminator}{(\link{Terminator})\cr +\item{terminator}{(\link[bbotk:Terminator]{bbotk::Terminator})\cr Stop criterion of the feature selection.} \item{store_fselect_instance}{(\code{logical(1)})\cr diff --git a/man/fsi.Rd b/man/fsi.Rd index a33dacbe..ee297749 100644 --- a/man/fsi.Rd +++ b/man/fsi.Rd @@ -33,7 +33,7 @@ Already instantiated resamplings are kept unchanged.} A single measure creates a \link{FSelectInstanceBatchSingleCrit} and multiple measures a \link{FSelectInstanceBatchMultiCrit}. If \code{NULL}, default measure is used.} -\item{terminator}{(\link{Terminator})\cr +\item{terminator}{(\link[bbotk:Terminator]{bbotk::Terminator})\cr Stop criterion of the feature selection.} \item{store_benchmark_result}{(\code{logical(1)})\cr