Skip to content

Commit

Permalink
Documents the instances where parsnip sets the default range of a tun…
Browse files Browse the repository at this point in the history
…able parameter via `set_model_arg()`. Also removes documentation for mars model earth engine that described non-implemented functionality for `num_terms`. (#1150)
  • Loading branch information
rkb965 authored Aug 28, 2024
1 parent ed86b96 commit 4acfa5e
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 1 deletion.
2 changes: 2 additions & 0 deletions man/rmd/bart_dbarts.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ This model has `r nrow(param)` tuning parameters:
param$item
```

Parsnip changes the default range for `trees` to `c(50, 500)`.

## Important engine-specific options

Some relevant arguments that can be passed to `set_engine()`:
Expand Down
2 changes: 1 addition & 1 deletion man/rmd/mars_earth.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This model has `r nrow(param)` tuning parameters:
param$item
```

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).
Parsnip changes the default range for `num_terms` to `c(50, 500)`.

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

Expand Down
1 change: 1 addition & 0 deletions man/rmd/mlp_brulee.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Other engine arguments of interest:
- `class_weights()`: Numeric class weights. See [brulee::brulee_mlp()].
- `stop_iter()`: A non-negative integer for how many iterations with no improvement before stopping. (default: 5L).

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

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

Expand Down
3 changes: 3 additions & 0 deletions man/rmd/nearest_neighbor_kknn.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ This model has `r nrow(param)` tuning parameters:
param$item
```

Parsnip changes the default range for `neighbors` to `c(1, 15)` and `dist_power` to `c(1/10, 2)`.


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

```{r kknn-reg}
Expand Down
2 changes: 2 additions & 0 deletions man/rmd/svm_linear_LiblineaR.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ param$item

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

Parsnip changes the default range for `cost` to `c(-10, 5)`.

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

```{r LiblineaR-reg}
Expand Down
2 changes: 2 additions & 0 deletions man/rmd/svm_linear_kernlab.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ This model has `r nrow(param)` tuning parameters:
param$item
```

Parsnip changes the default range for `cost` to `c(-10, 5)`.

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

```{r kernlab-reg}
Expand Down
2 changes: 2 additions & 0 deletions man/rmd/svm_poly_kernlab.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ This model has `r nrow(param)` tuning parameters:
param$item
```

Parsnip changes the default range for `cost` to `c(-10, 5)`.

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

```{r kernlab-reg}
Expand Down
2 changes: 2 additions & 0 deletions man/rmd/svm_rbf_kernlab.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ param$item

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.

Parsnip changes the default range for `cost` to `c(-10, 5)`.

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

```{r kernlab-reg}
Expand Down

0 comments on commit 4acfa5e

Please sign in to comment.