Skip to content

Commit 4acfa5e

Browse files
authored
Documents the instances where parsnip sets the default range of a tunable parameter via set_model_arg(). Also removes documentation for mars model earth engine that described non-implemented functionality for num_terms. (#1150)
1 parent ed86b96 commit 4acfa5e

8 files changed

+15
-1
lines changed

man/rmd/bart_dbarts.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ This model has `r nrow(param)` tuning parameters:
2525
param$item
2626
```
2727

28+
Parsnip changes the default range for `trees` to `c(50, 500)`.
29+
2830
## Important engine-specific options
2931

3032
Some relevant arguments that can be passed to `set_engine()`:

man/rmd/mars_earth.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This model has `r nrow(param)` tuning parameters:
2222
param$item
2323
```
2424

25-
The default value of `num_terms` depends on the number of predictor columns. For a data frame `x`, the default is `min(200, max(20, 2 * ncol(x))) + 1` (see [earth::earth()] and the reference below).
25+
Parsnip changes the default range for `num_terms` to `c(50, 500)`.
2626

2727
## Translation from parsnip to the original package (regression)
2828

man/rmd/mlp_brulee.Rmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Other engine arguments of interest:
3333
- `class_weights()`: Numeric class weights. See [brulee::brulee_mlp()].
3434
- `stop_iter()`: A non-negative integer for how many iterations with no improvement before stopping. (default: 5L).
3535

36+
Parsnip changes the default range for `learn_rate` to `c(-2.5, -0.5)`.
3637

3738
## Translation from parsnip to the original package (regression)
3839

man/rmd/nearest_neighbor_kknn.Rmd

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ This model has `r nrow(param)` tuning parameters:
2222
param$item
2323
```
2424

25+
Parsnip changes the default range for `neighbors` to `c(1, 15)` and `dist_power` to `c(1/10, 2)`.
26+
27+
2528
## Translation from parsnip to the original package (regression)
2629

2730
```{r kknn-reg}

man/rmd/svm_linear_LiblineaR.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ param$item
2424

2525
This engine fits models that are L2-regularized for L2-loss. In the [LiblineaR::LiblineaR()] documentation, these are types 1 (classification) and 11 (regression).
2626

27+
Parsnip changes the default range for `cost` to `c(-10, 5)`.
28+
2729
## Translation from parsnip to the original package (regression)
2830

2931
```{r LiblineaR-reg}

man/rmd/svm_linear_kernlab.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ This model has `r nrow(param)` tuning parameters:
2222
param$item
2323
```
2424

25+
Parsnip changes the default range for `cost` to `c(-10, 5)`.
26+
2527
## Translation from parsnip to the original package (regression)
2628

2729
```{r kernlab-reg}

man/rmd/svm_poly_kernlab.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ This model has `r nrow(param)` tuning parameters:
2222
param$item
2323
```
2424

25+
Parsnip changes the default range for `cost` to `c(-10, 5)`.
26+
2527
## Translation from parsnip to the original package (regression)
2628

2729
```{r kernlab-reg}

man/rmd/svm_rbf_kernlab.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ param$item
2424

2525
There is no default for the radial basis function kernel parameter. kernlab estimates it from the data using a heuristic method. See [kernlab::sigest()]. This method uses random numbers so, without setting the seed before fitting, the model will not be reproducible.
2626

27+
Parsnip changes the default range for `cost` to `c(-10, 5)`.
28+
2729
## Translation from parsnip to the original package (regression)
2830

2931
```{r kernlab-reg}

0 commit comments

Comments
 (0)