diff --git a/DESCRIPTION b/DESCRIPTION index 9eda0314..59a50c8a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -57,4 +57,4 @@ RdMacros: mlr3misc Encoding: UTF-8 NeedsCompilation: no Roxygen: list(markdown = TRUE, r6 = FALSE) -RoxygenNote: 7.0.0 +RoxygenNote: 7.0.1 diff --git a/R/LearnerClassifXgboost.R b/R/LearnerClassifXgboost.R index 9773b8d6..c7fdd864 100644 --- a/R/LearnerClassifXgboost.R +++ b/R/LearnerClassifXgboost.R @@ -15,6 +15,10 @@ #' eXtreme Gradient Boosting classification. #' Calls [xgboost::xgb.train()] from package \CRANpkg{xgboost}. #' +#' We changed the following defaults for this learner: +#' * Verbosity is reduced by setting `verbose` to `0`. +#' * Number of boosting iterations `nrounds` is set to `1`. +#' #' @references #' \cite{mlr3learners}{chen_2016} #' diff --git a/R/LearnerRegrGlmnet.R b/R/LearnerRegrGlmnet.R index f3bd7ac8..6b6d528a 100644 --- a/R/LearnerRegrGlmnet.R +++ b/R/LearnerRegrGlmnet.R @@ -14,7 +14,8 @@ #' @description #' Generalized linear models with elastic net regularization. #' Calls [glmnet::cv.glmnet()] from package \CRANpkg{glmnet}. -#' Hyperparameter `family` is set to `"gaussian"`. +#' +#' The default for hyperparameter `family` is changed to `"gaussian"`. #' #' @references #' \cite{mlr3learners}{friedman_2010} diff --git a/R/LearnerRegrXgboost.R b/R/LearnerRegrXgboost.R index 6f9e5aa0..88398698 100644 --- a/R/LearnerRegrXgboost.R +++ b/R/LearnerRegrXgboost.R @@ -15,6 +15,10 @@ #' eXtreme Gradient Boosting regression. #' Calls [xgboost::xgb.train()] from package \CRANpkg{xgboost}. #' +#' We changed the following defaults for this learner: +#' * Verbosity is reduced by setting `verbose` to `0`. +#' * Number of boosting iterations `nrounds` is set to `1`. +#' #' @references #' \cite{mlr3learners}{chen_2016} #' diff --git a/man/LearnerClassifXgboost.Rd b/man/LearnerClassifXgboost.Rd index db360e10..24fd5684 100644 --- a/man/LearnerClassifXgboost.Rd +++ b/man/LearnerClassifXgboost.Rd @@ -8,6 +8,12 @@ \description{ eXtreme Gradient Boosting classification. Calls \code{\link[xgboost:xgb.train]{xgboost::xgb.train()}} from package \CRANpkg{xgboost}. + +We changed the following defaults for this learner: +\itemize{ +\item Verbosity is reduced by setting \code{verbose} to \code{0}. +\item Number of boosting iterations \code{nrounds} is set to \code{1}. +} } \section{Construction}{ \preformatted{LearnerClassifXgboost$new() diff --git a/man/LearnerRegrGlmnet.Rd b/man/LearnerRegrGlmnet.Rd index 96c170f9..0cd653bd 100644 --- a/man/LearnerRegrGlmnet.Rd +++ b/man/LearnerRegrGlmnet.Rd @@ -8,7 +8,8 @@ \description{ Generalized linear models with elastic net regularization. Calls \code{\link[glmnet:cv.glmnet]{glmnet::cv.glmnet()}} from package \CRANpkg{glmnet}. -Hyperparameter \code{family} is set to \code{"gaussian"}. + +The default for hyperparameter \code{family} is changed to \code{"gaussian"}. } \section{Construction}{ \preformatted{LearnerRegrGlmnet$new() diff --git a/man/LearnerRegrXgboost.Rd b/man/LearnerRegrXgboost.Rd index ae7451dd..877f31cb 100644 --- a/man/LearnerRegrXgboost.Rd +++ b/man/LearnerRegrXgboost.Rd @@ -8,6 +8,12 @@ \description{ eXtreme Gradient Boosting regression. Calls \code{\link[xgboost:xgb.train]{xgboost::xgb.train()}} from package \CRANpkg{xgboost}. + +We changed the following defaults for this learner: +\itemize{ +\item Verbosity is reduced by setting \code{verbose} to \code{0}. +\item Number of boosting iterations \code{nrounds} is set to \code{1}. +} } \section{Construction}{ \preformatted{LearnerRegrXgboost$new()