Skip to content

Commit 3fd86f6

Browse files
committed
doc update
1 parent a07a71b commit 3fd86f6

13 files changed

+41
-22
lines changed

man/details_boost_tree_lightgbm.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/details_decision_tree_partykit.Rd

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

man/details_linear_reg_lme.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/details_rand_forest_aorsf.Rd

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

man/details_rand_forest_partykit.Rd

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

man/details_rand_forest_ranger.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/parsnip-package.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/rmd/boost_tree_lightgbm.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,11 @@ To effectively enable bagging, the user would also need to set the `bagging_freq
133133

134134
bonsai quiets much of the logging output from [lightgbm::lgb.train()] by default. With default settings, logged warnings and errors will still be passed on to the user. To print out all logs during training, set `quiet = TRUE`.
135135

136+
## Sparse Data
137+
138+
139+
This model can utilize sparse data during model fitting and prediction. Both sparse matrices such as dgCMatrix from the `Matrix` package and sparse tibbles from the `sparsevctrs` package are supported. See [sparse_data] for more information.
140+
136141
## Examples
137142

138143
The "Introduction to bonsai" article contains [examples](https://bonsai.tidymodels.org/articles/bonsai.html) of `boost_tree()` with the `"lightgbm"` engine.

man/rmd/decision_tree_partykit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11

22

33

4-
For this engine, there are multiple modes: regression, classification, and censored regression
4+
For this engine, there are multiple modes: censored regression, regression, and classification
55

66
## Tuning Parameters
77

88

99

1010
This model has 2 tuning parameters:
1111

12-
- `min_n`: Minimal Node Size (type: integer, default: 20L)
13-
1412
- `tree_depth`: Tree Depth (type: integer, default: see below)
1513

14+
- `min_n`: Minimal Node Size (type: integer, default: 20L)
15+
1616
The `tree_depth` parameter defaults to `0` which means no restrictions are applied to tree depth.
1717

1818
An engine-specific parameter for this model is:

man/rmd/linear_reg_lme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This model can use subject-specific coefficient estimates to make predictions (i
3939
\eta_{i} = (\beta_0 + b_{0i}) + \beta_1x_{i1}
4040
```
4141

42-
where $i$ denotes the `i`th independent experimental unit (e.g. subject). When the model has seen subject `i`, it can use that subject's data to adjust the _population_ intercept to be more specific to that subjects results.
42+
where `i` denotes the `i`th independent experimental unit (e.g. subject). When the model has seen subject `i`, it can use that subject's data to adjust the _population_ intercept to be more specific to that subjects results.
4343

4444
What happens when data are being predicted for a subject that was not used in the model fit? In that case, this package uses _only_ the population parameter estimates for prediction:
4545

0 commit comments

Comments
 (0)