Skip to content

Commit 02bfa33

Browse files
committed
more documentation for #362
1 parent c8efde3 commit 02bfa33

File tree

6 files changed

+27
-0
lines changed

6 files changed

+27
-0
lines changed

man/boost_tree.Rd

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mars.Rd

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/nearest_neighbor.Rd

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/rmd/boost-tree.Rmd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ mod_param <-
3838
update(sample_size = sample_prop(c(0.4, 0.9)))
3939
```
4040

41+
For this engine, tuning over `trees` is very efficient since the same model
42+
object can be used to make predictions over multiple values of `trees`.
43+
4144
Finally, note that `xgboost` models require that non-numeric predictors (e.g., factors) must be converted to dummy variables or some other numeric representation. By default, when using `fit()` with `xgboost`, a one-hot encoding is used to convert factor predictors to indicator variables.
4245

4346

@@ -52,6 +55,9 @@ boost_tree() %>%
5255

5356
Note that [C50::C5.0()] does not require factor predictors to be converted to indicator variables. `fit()` does not affect the encoding of the predictor values (i.e. factors stay factors) for this model.
5457

58+
For this engine, tuning over `trees` is very efficient since the same model
59+
object can be used to make predictions over multiple values of `trees`.
60+
5561
## spark
5662

5763
```{r spark-reg}

man/rmd/mars.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Note that, when the model is fit, the `earth` package only has its namespace lo
2626

2727
Also, `fit()` passes the data directly to `earth::earth()` so that its formula method can create dummy variables as-needed.
2828

29+
For this engine, tuning over `num_terms` is very efficient since the same model
30+
object can be used to make predictions over multiple values of `num_terms`.
2931

3032
## Parameter translations
3133

man/rmd/nearest-neighbor.Rmd

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ utilize the underlying `predict.train.kknn` method to predict on new data. This
2727
also means that a single value of that function's `kernel` argument (a.k.a
2828
`weight_func` here) can be supplied
2929

30+
For this engine, tuning over `neighbors` is very efficient since the same model
31+
object can be used to make predictions over multiple values of `neighbors`.
32+
3033
## Parameter translations
3134

3235
The standardized parameter names in parsnip can be mapped to their original

0 commit comments

Comments
 (0)