Merge branch 'main' into model-formula

tidymodels · Nov 6, 2023 · a7c4ac4 · a7c4ac4
2 parents 9fa3100 + 975a703
commit a7c4ac4
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 7 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -4,6 +4,7 @@
 
 * Improved errors in cases where the outcome column is mis-specified. (#1003)
 
+* Fixed documentation for `mlp(engine = "brulee")`: the default values for `learn_rate` and `epochs` were swapped (#1018).
 
 # parsnip 1.1.1
 

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/rmd/mlp_brulee.Rmd b/man/rmd/mlp_brulee.Rmd
@@ -8,7 +8,7 @@
 ```{r brulee-param-info, echo = FALSE}
 defaults <- 
   tibble::tibble(parsnip = c("hidden_units", "penalty", "dropout", "epochs", "learn_rate", "activation", "mixture"),
-                 default = c("3L", "0.0", "0.0", "0.01", "100L", "'relu'", "0.0"))
+                 default = c("3L", "0.0", "0.0", "100L", "0.01", "'relu'", "0.0"))
 
 param <-
   mlp() %>% 

diff --git a/man/rmd/mlp_brulee.md b/man/rmd/mlp_brulee.md
@@ -15,11 +15,11 @@ This model has 7 tuning parameters:
 
 - `mixture`: Proportion of Lasso Penalty (type: double, default: 0.0)
 
-- `epochs`: # Epochs (type: integer, default: 0.01)
+- `epochs`: # Epochs (type: integer, default: 100L)
 
 - `dropout`: Dropout Rate (type: double, default: 0.0)
 
-- `learn_rate`: Learning Rate (type: double, default: 100L)
+- `learn_rate`: Learning Rate (type: double, default: 0.01)
 
 - `activation`: Activation Function (type: character, default: 'relu')
 

diff --git a/man/rule_fit.Rd b/man/rule_fit.Rd
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,6 +4,7 @@

		* Improved errors in cases where the outcome column is mis-specified. (#1003)

		* Fixed documentation for `mlp(engine = "brulee")`: the default values for `learn_rate` and `epochs` were swapped (#1018).

		# parsnip 1.1.1

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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)


Expand Down