Merge pull request #1021 from tidymodels/doc-xgboost-mtry-default-value

Document what `mtry = NULL` means for xgboost
tidymodels · Nov 6, 2023 · 975a703 · 975a703
2 parents f868e94 + cafc16e
commit 975a703
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 4 deletions.
diff --git a/R/boost_tree.R b/R/boost_tree.R
@@ -21,7 +21,7 @@
 #'  to use for fitting.
 #' @param mtry A number for the number (or proportion) of predictors that will
 #'  be randomly sampled at each split when creating the tree models
-#' (specific engines only)
+#' (specific engines only).
 #' @param trees An integer for the number of trees contained in
 #'  the ensemble.
 #' @param min_n An integer for the minimum number of data points

diff --git a/man/boost_tree.Rd b/man/boost_tree.Rd
diff --git a/man/parsnip_update.Rd b/man/parsnip_update.Rd
diff --git a/man/rmd/boost_tree_xgboost.Rmd b/man/rmd/boost_tree_xgboost.Rmd
@@ -24,6 +24,8 @@ This model has `r nrow(param)` tuning parameters:
 param$item
 ```
 
+For `mtry`, the default value of `NULL` translates to using all available columns.
+
 ## Translation from parsnip to the original package (regression)
 
 ```{r xgboost-reg}

diff --git a/man/rmd/boost_tree_xgboost.md b/man/rmd/boost_tree_xgboost.md
@@ -25,6 +25,8 @@ This model has 8 tuning parameters:
 
 - `stop_iter`: # Iterations Before Stopping (type: integer, default: Inf)
 
+For `mtry`, the default value of `NULL` translates to using all available columns.
+
 ## Translation from parsnip to the original package (regression)
 
 

diff --git a/man/rule_fit.Rd b/man/rule_fit.Rd