From 3c523498ba88e2506de3f20ca3ede5b6215e686b Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Mon, 6 Nov 2023 16:14:30 +0000 Subject: [PATCH 1/2] clarify default value --- man/rmd/boost_tree_xgboost.Rmd | 2 ++ man/rmd/boost_tree_xgboost.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/man/rmd/boost_tree_xgboost.Rmd b/man/rmd/boost_tree_xgboost.Rmd index 8490eb565..584319237 100644 --- 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 index 8a1dbf48b..1d8a45e69 100644 --- 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) From cafc16e307165694f6125e18db1726b5ca0ebb9a Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Mon, 6 Nov 2023 16:15:43 +0000 Subject: [PATCH 2/2] end with `.` like the others --- R/boost_tree.R | 2 +- man/boost_tree.Rd | 2 +- man/parsnip_update.Rd | 2 +- man/rule_fit.Rd | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/boost_tree.R b/R/boost_tree.R index 60c0417a8..59cbf6f79 100644 --- 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 index a81df53ab..aa7ff82b8 100644 --- a/man/boost_tree.Rd +++ b/man/boost_tree.Rd @@ -27,7 +27,7 @@ to use for fitting.} \item{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).} \item{trees}{An integer for the number of trees contained in the ensemble.} diff --git a/man/parsnip_update.Rd b/man/parsnip_update.Rd index ab3f67a93..7cbf4ef0d 100644 --- a/man/parsnip_update.Rd +++ b/man/parsnip_update.Rd @@ -370,7 +370,7 @@ on the logit scale). The default value is 2.} \item{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).} \item{learn_rate}{A number for the rate at which the boosting algorithm adapts from iteration-to-iteration (specific engines only). This is sometimes referred to diff --git a/man/rule_fit.Rd b/man/rule_fit.Rd index 6bd0c4aca..5fc65b082 100644 --- a/man/rule_fit.Rd +++ b/man/rule_fit.Rd @@ -25,7 +25,7 @@ Possible values for this model are "unknown", "regression", or \item{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).} \item{trees}{An integer for the number of trees contained in the ensemble.}