From cf8f77ee3bda0654543a302a5c7955958bfc41b6 Mon Sep 17 00:00:00 2001 From: schalkdaniel Date: Tue, 28 Mar 2023 15:33:59 +0200 Subject: [PATCH] updates --- DESCRIPTION | 4 +- R/RcppExports.R | 1 + cran-comments.md | 13 +-- man/Compboost.Rd | 144 ++++++++++++++++----------------- man/Compboost_internal.Rd | 9 +-- man/LearnerClassifCompboost.Rd | 46 +++++------ man/LearnerCompboost.Rd | 62 +++++++------- man/LearnerRegrCompboost.Rd | 46 +++++------ src/compboost_modules.cpp | 1 + 9 files changed, 155 insertions(+), 171 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 43542cbc..a04f2e18 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -6,7 +6,7 @@ Authors@R: c( person(given = "Daniel", family = "Schalk", email = "schalkdaniel242@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-0950-1947")), person(given = "Janek", family = "Thomas", email = "janek.thomas@stat.uni-muenchen.de", role = "aut", comment = c(ORCID = "0000-0003-4511-6245")), person(given = "Bernd", family = "Bischl", email = "bernd_bischl@gmx.net", role = "aut", comment = c(ORCID = "0000-0001-6002-6980"))) -Maintainer: Daniel Schalk +Maintainer: Daniel Schalk Description: Efficient implementation of component-wise gradient boosting. The package applies the boosting framework to statistical models, e.g., general additive models using component-wise smoothing splines. @@ -18,7 +18,7 @@ BugReports: https://github.com/schalkdaniel/compboost/issues Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE, r6 = TRUE) -RoxygenNote: 7.1.1 +RoxygenNote: 7.2.3 Depends: R (>= 3.4.0) Imports: diff --git a/R/RcppExports.R b/R/RcppExports.R index f27a2a57..45a2c793 100644 --- a/R/RcppExports.R +++ b/R/RcppExports.R @@ -1466,6 +1466,7 @@ NULL #' @title Internal Compboost Class #' +#' @description #' This class is the raw `C++` pendant and still at a very high-level. #' It is the base for the [Compboost] [R6] class and provides #' many convenient wrapper to access data and execute methods by calling diff --git a/cran-comments.md b/cran-comments.md index 56e7c984..e7c4ad92 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -13,7 +13,7 @@ Remote environments via GitHub Actions, checks are run with `--as-cran` ## R CMD check results There were no ERRORs or WARNINGs. -There was 2 NOTE: +There were 2 NOTEs: ``` checking installed package size ... NOTE @@ -26,14 +26,3 @@ sub-directories of 1Mb or more: * This is a new release. * Shared object created by Rcpp is greater than 1Mb. * Using math equations in the vignettes increases the size of two vignettes to ~800 kB and ~600 kB. - -``` -checking HTML version of manual ... [10s] NOTE -Found the following HTML validation problems: -mlr_learners.compboost.html:63:6 (mlr_learners.compboost.Rd:27): Warning: missing before

-mlr_learners.compboost.html:63:92 (mlr_learners.compboost.Rd:27): Warning: inserting implicit -mlr_learners.compboost.html:66:6 (mlr_learners.compboost.Rd:28): Warning: missing before

-... -``` - -* I was not able to reproduce the error on my machine. Hence it is tough to debug the problem here. diff --git a/man/Compboost.Rd b/man/Compboost.Rd index 87321f66..0297c70c 100644 --- a/man/Compboost.Rd +++ b/man/Compboost.Rd @@ -133,35 +133,35 @@ Note: \code{oob_fraction} is ignored if this argument is set.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Compboost$new()}} -\item \href{#method-addLogger}{\code{Compboost$addLogger()}} -\item \href{#method-getCurrentIteration}{\code{Compboost$getCurrentIteration()}} -\item \href{#method-addIntercept}{\code{Compboost$addIntercept()}} -\item \href{#method-addBaselearner}{\code{Compboost$addBaselearner()}} -\item \href{#method-rmBaselearner}{\code{Compboost$rmBaselearner()}} -\item \href{#method-addTensor}{\code{Compboost$addTensor()}} -\item \href{#method-addComponents}{\code{Compboost$addComponents()}} -\item \href{#method-train}{\code{Compboost$train()}} -\item \href{#method-prepareData}{\code{Compboost$prepareData()}} -\item \href{#method-prepareResponse}{\code{Compboost$prepareResponse()}} -\item \href{#method-predict}{\code{Compboost$predict()}} -\item \href{#method-predictIndividual}{\code{Compboost$predictIndividual()}} -\item \href{#method-transformData}{\code{Compboost$transformData()}} -\item \href{#method-getInbagRisk}{\code{Compboost$getInbagRisk()}} -\item \href{#method-getSelectedBaselearner}{\code{Compboost$getSelectedBaselearner()}} -\item \href{#method-print}{\code{Compboost$print()}} -\item \href{#method-getCoef}{\code{Compboost$getCoef()}} -\item \href{#method-getEstimatedCoef}{\code{Compboost$getEstimatedCoef()}} -\item \href{#method-getBaselearnerNames}{\code{Compboost$getBaselearnerNames()}} -\item \href{#method-getLoggerData}{\code{Compboost$getLoggerData()}} -\item \href{#method-calculateFeatureImportance}{\code{Compboost$calculateFeatureImportance()}} -\item \href{#method-saveToJson}{\code{Compboost$saveToJson()}} -\item \href{#method-clone}{\code{Compboost$clone()}} +\item \href{#method-Compboost-new}{\code{Compboost$new()}} +\item \href{#method-Compboost-addLogger}{\code{Compboost$addLogger()}} +\item \href{#method-Compboost-getCurrentIteration}{\code{Compboost$getCurrentIteration()}} +\item \href{#method-Compboost-addIntercept}{\code{Compboost$addIntercept()}} +\item \href{#method-Compboost-addBaselearner}{\code{Compboost$addBaselearner()}} +\item \href{#method-Compboost-rmBaselearner}{\code{Compboost$rmBaselearner()}} +\item \href{#method-Compboost-addTensor}{\code{Compboost$addTensor()}} +\item \href{#method-Compboost-addComponents}{\code{Compboost$addComponents()}} +\item \href{#method-Compboost-train}{\code{Compboost$train()}} +\item \href{#method-Compboost-prepareData}{\code{Compboost$prepareData()}} +\item \href{#method-Compboost-prepareResponse}{\code{Compboost$prepareResponse()}} +\item \href{#method-Compboost-predict}{\code{Compboost$predict()}} +\item \href{#method-Compboost-predictIndividual}{\code{Compboost$predictIndividual()}} +\item \href{#method-Compboost-transformData}{\code{Compboost$transformData()}} +\item \href{#method-Compboost-getInbagRisk}{\code{Compboost$getInbagRisk()}} +\item \href{#method-Compboost-getSelectedBaselearner}{\code{Compboost$getSelectedBaselearner()}} +\item \href{#method-Compboost-print}{\code{Compboost$print()}} +\item \href{#method-Compboost-getCoef}{\code{Compboost$getCoef()}} +\item \href{#method-Compboost-getEstimatedCoef}{\code{Compboost$getEstimatedCoef()}} +\item \href{#method-Compboost-getBaselearnerNames}{\code{Compboost$getBaselearnerNames()}} +\item \href{#method-Compboost-getLoggerData}{\code{Compboost$getLoggerData()}} +\item \href{#method-Compboost-calculateFeatureImportance}{\code{Compboost$calculateFeatureImportance()}} +\item \href{#method-Compboost-saveToJson}{\code{Compboost$saveToJson()}} +\item \href{#method-Compboost-clone}{\code{Compboost$clone()}} } } \if{html}{\out{

}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -225,8 +225,8 @@ File from which a model should be loaded. If \code{NULL}, \code{data} and \code{ } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-addLogger}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-addLogger}{}}} \subsection{Method \code{addLogger()}}{ Add a logger to the model. \subsection{Usage}{ @@ -251,8 +251,8 @@ The id of the logger. This allows to define two logger of the same type (\verb{e } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-getCurrentIteration}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-getCurrentIteration}{}}} \subsection{Method \code{getCurrentIteration()}}{ Get the number of the current iteration. \subsection{Usage}{ @@ -264,8 +264,8 @@ Get the number of the current iteration. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-addIntercept}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-addIntercept}{}}} \subsection{Method \code{addIntercept()}}{ This functions adds a base learner that adjusts the intercept (if selected). Adding an intercept base learner may be necessary, e.g., when adding linear effects @@ -292,8 +292,8 @@ storing is supported, see \code{?InMemorydata} for details.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-addBaselearner}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-addBaselearner}{}}} \subsection{Method \code{addBaselearner()}}{ Add a base learner of one feature to the model that is considered in each iteration. Using \verb{$addBaselearner()} just allows including univariate features. See \verb{$addTensor()} for @@ -337,8 +337,8 @@ storing is supported, see \code{?InMemorydata} for details.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-rmBaselearner}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-rmBaselearner}{}}} \subsection{Method \code{rmBaselearner()}}{ Remove a base learner from the model. \subsection{Usage}{ @@ -355,8 +355,8 @@ Name of the base learner that should be removed. Must be an element of \verb{$ge } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-addTensor}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-addTensor}{}}} \subsection{Method \code{addTensor()}}{ Add a row-wise tensor product of features. Note: The base learner are pre-defined by the type of the feature. Numerical features uses a \code{BaselearnerPSpline} while categorical @@ -404,8 +404,8 @@ the total degrees of freedom are uniformly distributed over the dimensions while } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-addComponents}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-addComponents}{}}} \subsection{Method \code{addComponents()}}{ Add an effect with individual components. A linear term is added as well as a non-linear term without the linear effect. This ensures that the linear @@ -434,8 +434,8 @@ Name of the feature, must be a column in \code{data}.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-train}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-train}{}}} \subsection{Method \code{train()}}{ Start fitting a model. \subsection{Usage}{ @@ -458,8 +458,8 @@ To silently fit the model use \code{trace = 0}.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-prepareData}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-prepareData}{}}} \subsection{Method \code{prepareData()}}{ Internally, each base learner is build on a \link{InMemoryData} object. Some methods (e.g. adding a \link{LoggerOobRisk}) requires to pass the data as @@ -493,8 +493,8 @@ are included with \link{CategoricalDataRaw}. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-prepareResponse}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-prepareResponse}{}}} \subsection{Method \code{prepareResponse()}}{ Same as for \verb{$prepareData()} but for the response. Internally, \code{vectorToResponse()} is used to generate a \link{ResponseRegr} or \link{ResponseBinaryClassif} object. @@ -516,8 +516,8 @@ response object.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-predict}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-predict}{}}} \subsection{Method \code{predict()}}{ Calculate predictions. \subsection{Usage}{ @@ -550,8 +550,8 @@ Vector of predictions. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-predictIndividual}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-predictIndividual}{}}} \subsection{Method \code{predictIndividual()}}{ While \verb{$predict()} returns the sum of all base learner predictions, this function returns a \code{list} with the predictions for each base learner. @@ -582,8 +582,8 @@ predictions as elements. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-transformData}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-transformData}{}}} \subsection{Method \code{transformData()}}{ Get design matrices of all (or a subset) base learners for a new \code{data.frame}. \subsection{Usage}{ @@ -617,8 +617,8 @@ constructed based on the feature names of \code{newdata}.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-getInbagRisk}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-getInbagRisk}{}}} \subsection{Method \code{getInbagRisk()}}{ Return the training risk of each iteration. \subsection{Usage}{ @@ -630,8 +630,8 @@ Return the training risk of each iteration. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-getSelectedBaselearner}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-getSelectedBaselearner}{}}} \subsection{Method \code{getSelectedBaselearner()}}{ Get a vector with the name of the selected base learner of each iteration. \subsection{Usage}{ @@ -643,8 +643,8 @@ Get a vector with the name of the selected base learner of each iteration. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-print}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-print}{}}} \subsection{Method \code{print()}}{ Printer of the object. \subsection{Usage}{ @@ -656,8 +656,8 @@ Invisibly returns the object. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-getCoef}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-getCoef}{}}} \subsection{Method \code{getCoef()}}{ Get the estimated coefficients. \subsection{Usage}{ @@ -669,8 +669,8 @@ Get the estimated coefficients. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-getEstimatedCoef}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-getEstimatedCoef}{}}} \subsection{Method \code{getEstimatedCoef()}}{ DEPRICATED use \verb{$getCoef()} instead. Get the estimated coefficients. @@ -683,8 +683,8 @@ Get the estimated coefficients. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-getBaselearnerNames}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-getBaselearnerNames}{}}} \subsection{Method \code{getBaselearnerNames()}}{ Get the names of the registered base learners. \subsection{Usage}{ @@ -696,8 +696,8 @@ Get the names of the registered base learners. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-getLoggerData}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-getLoggerData}{}}} \subsection{Method \code{getLoggerData()}}{ Get the logged information. \subsection{Usage}{ @@ -709,8 +709,8 @@ Get the logged information. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-calculateFeatureImportance}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-calculateFeatureImportance}{}}} \subsection{Method \code{calculateFeatureImportance()}}{ Calculate feature important based on the training risk. Note that early stopping should be used to get adequate importance measures. @@ -742,8 +742,8 @@ with importance values as elements. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-saveToJson}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-saveToJson}{}}} \subsection{Method \code{saveToJson()}}{ Save a \link{Compboost} object to a JSON file. Because of the underlying \code{C++} objects, it is not possible to use \code{R}'s native load and save methods. @@ -767,8 +767,8 @@ predictions based on the training data throws an error.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Compboost-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/Compboost_internal.Rd b/man/Compboost_internal.Rd index f65954e3..b497f1f4 100644 --- a/man/Compboost_internal.Rd +++ b/man/Compboost_internal.Rd @@ -2,12 +2,7 @@ % Please edit documentation in R/RcppExports.R \name{Compboost_internal} \alias{Compboost_internal} -\title{Internal Compboost Class - -This class is the raw \verb{C++} pendant and still at a very high-level. -It is the base for the \link{Compboost} \link{R6} class and provides -many convenient wrapper to access data and execute methods by calling -the \verb{C++} methods.} +\title{Internal Compboost Class} \format{ \link{S4} object. } @@ -38,8 +33,6 @@ An initialized \code{S4} optimizer object (requires to call \code{Optimizer*.new See the respective help page for further information.} } \description{ -Internal Compboost Class - This class is the raw \verb{C++} pendant and still at a very high-level. It is the base for the \link{Compboost} \link{R6} class and provides many convenient wrapper to access data and execute methods by calling diff --git a/man/LearnerClassifCompboost.Rd b/man/LearnerClassifCompboost.Rd index 6897dec1..780bea6b 100644 --- a/man/LearnerClassifCompboost.Rd +++ b/man/LearnerClassifCompboost.Rd @@ -19,30 +19,30 @@ l$selected_features() \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{LearnerClassifCompboost$new()}} -\item \href{#method-clone}{\code{LearnerClassifCompboost$clone()}} +\item \href{#method-LearnerClassifCompboost-new}{\code{LearnerClassifCompboost$new()}} +\item \href{#method-LearnerClassifCompboost-clone}{\code{LearnerClassifCompboost$clone()}} } } -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../mlr3/html/Learner.html#method-base_learner}{\code{mlr3::Learner$base_learner()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-format}{\code{mlr3::Learner$format()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-help}{\code{mlr3::Learner$help()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-predict}{\code{mlr3::Learner$predict()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-predict_newdata}{\code{mlr3::Learner$predict_newdata()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-print}{\code{mlr3::Learner$print()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-reset}{\code{mlr3::Learner$reset()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-train}{\code{mlr3::Learner$train()}}\out{} -\item \out{}\href{../../compboost/html/LearnerCompboost.html#method-importance}{\code{compboost::LearnerCompboost$importance()}}\out{} -\item \out{}\href{../../compboost/html/LearnerCompboost.html#method-save_json}{\code{compboost::LearnerCompboost$save_json()}}\out{} -\item \out{}\href{../../compboost/html/LearnerCompboost.html#method-selected_features}{\code{compboost::LearnerCompboost$selected_features()}}\out{} -} -\out{
} -} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-LearnerClassifCompboost-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -51,8 +51,8 @@ Creates a new instance of this \link[R6:R6Class]{R6} class. } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-LearnerClassifCompboost-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/LearnerCompboost.Rd b/man/LearnerCompboost.Rd index 45921f49..cf9828cc 100644 --- a/man/LearnerCompboost.Rd +++ b/man/LearnerCompboost.Rd @@ -12,30 +12,30 @@ A \link[mlr3:Learner]{Learner} for a component-wise boosting model implemented i \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{LearnerCompboost$new()}} -\item \href{#method-importance}{\code{LearnerCompboost$importance()}} -\item \href{#method-selected_features}{\code{LearnerCompboost$selected_features()}} -\item \href{#method-save_json}{\code{LearnerCompboost$save_json()}} -\item \href{#method-clone}{\code{LearnerCompboost$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../mlr3/html/Learner.html#method-base_learner}{\code{mlr3::Learner$base_learner()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-format}{\code{mlr3::Learner$format()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-help}{\code{mlr3::Learner$help()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-predict}{\code{mlr3::Learner$predict()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-predict_newdata}{\code{mlr3::Learner$predict_newdata()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-print}{\code{mlr3::Learner$print()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-reset}{\code{mlr3::Learner$reset()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-train}{\code{mlr3::Learner$train()}}\out{} -} -\out{
} -} +\item \href{#method-LearnerCompboost-new}{\code{LearnerCompboost$new()}} +\item \href{#method-LearnerCompboost-importance}{\code{LearnerCompboost$importance()}} +\item \href{#method-LearnerCompboost-selected_features}{\code{LearnerCompboost$selected_features()}} +\item \href{#method-LearnerCompboost-save_json}{\code{LearnerCompboost$save_json()}} +\item \href{#method-LearnerCompboost-clone}{\code{LearnerCompboost$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-LearnerCompboost-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -52,8 +52,8 @@ The task type of the learner. Must be \code{regr} or \code{classif}.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-importance}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-LearnerCompboost-importance}{}}} \subsection{Method \code{importance()}}{ The importance scores are extracted from the model slot \verb{$calculateFEatureImportance()}. \subsection{Usage}{ @@ -65,8 +65,8 @@ Named \code{numeric()}. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-selected_features}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-LearnerCompboost-selected_features}{}}} \subsection{Method \code{selected_features()}}{ Selected features are extracted from the model slot \verb{$getSelectedBaselearner()}. \subsection{Usage}{ @@ -78,8 +78,8 @@ Selected features are extracted from the model slot \verb{$getSelectedBaselearne } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-save_json}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-LearnerCompboost-save_json}{}}} \subsection{Method \code{save_json()}}{ Save the model to a JSON file. \subsection{Usage}{ @@ -99,8 +99,8 @@ Name/path to the file.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-LearnerCompboost-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/LearnerRegrCompboost.Rd b/man/LearnerRegrCompboost.Rd index 7c81e8a1..ada70ed2 100644 --- a/man/LearnerRegrCompboost.Rd +++ b/man/LearnerRegrCompboost.Rd @@ -18,30 +18,30 @@ l$importance() \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{LearnerRegrCompboost$new()}} -\item \href{#method-clone}{\code{LearnerRegrCompboost$clone()}} +\item \href{#method-LearnerRegrCompboost-new}{\code{LearnerRegrCompboost$new()}} +\item \href{#method-LearnerRegrCompboost-clone}{\code{LearnerRegrCompboost$clone()}} } } -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../mlr3/html/Learner.html#method-base_learner}{\code{mlr3::Learner$base_learner()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-format}{\code{mlr3::Learner$format()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-help}{\code{mlr3::Learner$help()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-predict}{\code{mlr3::Learner$predict()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-predict_newdata}{\code{mlr3::Learner$predict_newdata()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-print}{\code{mlr3::Learner$print()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-reset}{\code{mlr3::Learner$reset()}}\out{} -\item \out{}\href{../../mlr3/html/Learner.html#method-train}{\code{mlr3::Learner$train()}}\out{} -\item \out{}\href{../../compboost/html/LearnerCompboost.html#method-importance}{\code{compboost::LearnerCompboost$importance()}}\out{} -\item \out{}\href{../../compboost/html/LearnerCompboost.html#method-save_json}{\code{compboost::LearnerCompboost$save_json()}}\out{} -\item \out{}\href{../../compboost/html/LearnerCompboost.html#method-selected_features}{\code{compboost::LearnerCompboost$selected_features()}}\out{} -} -\out{
} -} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-LearnerRegrCompboost-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -50,8 +50,8 @@ Creates a new instance of this \link[R6:R6Class]{R6} class. } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-LearnerRegrCompboost-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/src/compboost_modules.cpp b/src/compboost_modules.cpp index 0bd2e929..bfdfaa88 100644 --- a/src/compboost_modules.cpp +++ b/src/compboost_modules.cpp @@ -3267,6 +3267,7 @@ RCPP_MODULE(optimizer_module) //' @title Internal Compboost Class //' +//' @description //' This class is the raw `C++` pendant and still at a very high-level. //' It is the base for the [Compboost] [R6] class and provides //' many convenient wrapper to access data and execute methods by calling