Skip to content

Commit 0ff7cda

Browse files
committed
add ?details_boost_tree_lightgbm doc
also, * re-knits rules xrf engine docs * corrects link to bonsai pkgdown site
1 parent 01ad62a commit 0ff7cda

File tree

6 files changed

+268
-12
lines changed

6 files changed

+268
-12
lines changed

R/boost_tree_lightgbm.R

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#' Boosted trees via lightgbm
2+
#'
3+
#' [lightgbm::lgb.train()] creates a series of decision trees
4+
#' forming an ensemble. Each tree depends on the results of previous trees.
5+
#' All trees in the ensemble are combined to produce a final prediction.
6+
#'
7+
#' @includeRmd man/rmd/boost_tree_lightgbm.md details
8+
#'
9+
#' @name details_boost_tree_lightgbm
10+
#' @keywords internal
11+
NULL
12+
13+
# See inst/README-DOCS.md for a description of how these files are processed

man/details_boost_tree_lightgbm.Rd

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

man/details_boost_tree_xgboost.Rd

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

man/details_rule_fit_xrf.Rd

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

man/rmd/boost_tree_lightgbm.Rmd

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,7 @@ bonsai quiets much of the logging output from [lightgbm::lgb.train()] by default
8080

8181
## Examples
8282

83-
<!-- TODO: update url to bonsai pkgdown site -->
84-
The "Introduction to bonsai" article contains [examples](https://github.com/tidymodels/bonsai) of `boost_tree()` with the `"lightgbm"` engine.
83+
The "Introduction to bonsai" article contains [examples](https://bonsai.tidymodels.org/articles/bonsai.html) of `boost_tree()` with the `"lightgbm"` engine.
8584

8685
## References
8786

man/rmd/boost_tree_lightgbm.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,7 @@ bonsai quiets much of the logging output from [lightgbm::lgb.train()] by default
127127

128128
## Examples
129129

130-
<!-- TODO: update url to bonsai pkgdown site -->
131-
The "Introduction to bonsai" article contains [examples](https://github.com/tidymodels/bonsai) of `boost_tree()` with the `"lightgbm"` engine.
130+
The "Introduction to bonsai" article contains [examples](https://bonsai.tidymodels.org/articles/bonsai.html) of `boost_tree()` with the `"lightgbm"` engine.
132131

133132
## References
134133

0 commit comments

Comments
 (0)