Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

extra docs for new engines #1120

Merged
merged 7 commits into from
May 14, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
h2 headers and engine-specific for translation
bcjaeger committed May 13, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 076fd6c94540e94a0b2bd3fcac72c15d2ec67da6
12 changes: 9 additions & 3 deletions man/rmd/rand_forest_aorsf.md
Original file line number Diff line number Diff line change
@@ -20,10 +20,9 @@ Additionally, this model has one engine-specific tuning parameter:
* `split_min_stat`: Minimum test statistic required to split a node. Defaults are `3.841459` for censored regression and `0` for classification and regression. For classification, this tuning parameter should be between 0 and 1, and for regression it should be greater than or equal to 0. Higher values of this parameter cause trees grown by `aorsf` to have less depth.


# Translation from parsnip to the original package

The **censored** extension package is required to fit this model with the censored regression engine, and **bonsai** is required for classification and regression engines.
## Translation from parsnip to the original package (censored regression)

The **censored** extension package is required to fit this model with the censored regression engine

```r
library(censored)
@@ -42,6 +41,9 @@ rand_forest() %>%
## Model fit template:
## aorsf::orsf(formula = missing_arg(), data = missing_arg(), weights = missing_arg())
```
## Translation from parsnip to the original package (regression)

The **bonsai** extension package is required to fit this model with the regression engine

```r
library(bonsai)
@@ -61,6 +63,10 @@ rand_forest() %>%
## aorsf::orsf(formula = missing_arg(), data = missing_arg(), weights = missing_arg(), n_thread = 1, verbose_progress = FALSE)
```

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

The **bonsai** extension package is required to fit this model with the classification engine

```r
library(bonsai)