document default changes

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

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}
 #'

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}

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}
 #'