Skip to content

Commit b95094f

Browse files
committed
Added "Predict type" section to each model type documentation.
1 parent cfd668b commit b95094f

File tree

98 files changed

+1057
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+1057
-3
lines changed

man/rmd/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/.quarto/
2+
**/*.quarto_ipynb

man/rmd/C5_rules_C5.0.Rmd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,16 @@ C5_rules(
6060
#| child: template-uses-case-weights.Rmd
6161
```
6262

63+
## Prediction types
64+
65+
```{r}
66+
#| label: predict-types
67+
68+
parsnip:::get_from_env("C5_rules_predict") |>
69+
dplyr::select(mode, type)
70+
71+
```
72+
6373
## Saving fitted model objects
6474

6575
```{r}

man/rmd/auto_ml_h2o.Rmd

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,12 @@ Engine arguments of interest
2323

2424
```{r}
2525
#| label: h2o-reg
26-
auto_ml() |>
27-
set_engine("h2o") |>
28-
set_mode("regression") |>
26+
27+
library(agua)
28+
29+
auto_ml() |>
30+
set_engine("h2o") |>
31+
set_mode("regression") |>
2932
translate()
3033
```
3134

@@ -52,6 +55,16 @@ auto_ml() |>
5255
#| child: template-h2o-init.Rmd
5356
```
5457

58+
## Prediction types
59+
60+
```{r}
61+
#| label: predict-types
62+
63+
parsnip:::get_from_env("auto_ml_predict") |>
64+
dplyr::select(mode, type)
65+
66+
```
67+
5568
## Saving fitted model objects
5669

5770
```{r}

man/rmd/bag_mars_earth.Rmd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,16 @@ bag_mars(
7575

7676
Note that the `earth` package documentation has: "In the current implementation, _building models with weights can be slow_."
7777

78+
## Prediction types
79+
80+
```{r}
81+
#| label: predict-types
82+
83+
parsnip:::get_from_env("bag_mars_predict") |>
84+
dplyr::select(mode, type)
85+
86+
```
87+
7888
## References
7989

8090
- Breiman, L. 1996. "Bagging predictors". Machine Learning. 24 (2): 123-140

man/rmd/bag_mlp_nnet.Rmd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,16 @@ bag_mlp(penalty = double(1), hidden_units = integer(1)) |>
7878
#| child: template-no-case-weights.Rmd
7979
```
8080

81+
## Prediction types
82+
83+
```{r}
84+
#| label: predict-types
85+
86+
parsnip:::get_from_env("bag_mlp_predict") |>
87+
dplyr::select(mode, type)
88+
89+
```
90+
8191

8292
## References
8393

man/rmd/bag_tree_C5.0.Rmd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,16 @@ bag_tree(min_n = integer()) |>
5656
#| child: template-uses-case-weights.Rmd
5757
```
5858

59+
## Prediction types
60+
61+
```{r}
62+
#| label: predict-types
63+
64+
parsnip:::get_from_env("bag_mars_predict") |>
65+
dplyr::filter(engine == "C5.0") |>
66+
dplyr::select(mode, type)
67+
68+
```
5969

6070
## References
6171

man/rmd/bag_tree_rpart.Rmd

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,17 @@ bag_tree(tree_depth = integer(1), min_n = integer(1), cost_complexity = double(1
8989
#| child: template-uses-case-weights.Rmd
9090
```
9191

92+
## Prediction types
93+
94+
```{r}
95+
#| label: predict-types
96+
97+
parsnip:::get_from_env("bag_mars_predict") |>
98+
dplyr::filter(engine == "rpart") |>
99+
dplyr::select(mode, type)
100+
101+
```
102+
92103
## Other details
93104

94105
```{r}

man/rmd/bart_dbarts.Rmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,15 @@ parsnip::bart(
9393

9494
[dbarts::bart()] will also convert the factors to indicators if the user does not create them first.
9595

96+
## Prediction types
97+
98+
```{r}
99+
#| label: predict-types
100+
101+
parsnip:::get_from_env("bart_predict") |>
102+
dplyr::select(mode, type)
103+
104+
```
96105

97106
## References
98107

man/rmd/boost_tree_C5.0.Rmd

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,17 @@ boost_tree(trees = integer(), min_n = integer(), sample_size = numeric()) |>
5656
#| child: template-uses-case-weights.Rmd
5757
```
5858

59+
## Prediction types
60+
61+
```{r}
62+
#| label: predict-types
63+
64+
parsnip:::get_from_env("boost_tree_predict") |>
65+
dplyr::filter(engine == "C5.0") |>
66+
dplyr::select(mode, type)
67+
68+
```
69+
5970
## Saving fitted model objects
6071

6172
```{r}

man/rmd/boost_tree_h2o.Rmd

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,17 @@ Non-numeric predictors (i.e., factors) are internally converted to numeric. In t
8282
#| child: template-mtry-prop.Rmd
8383
```
8484

85+
## Prediction types
86+
87+
```{r}
88+
#| label: predict-types
89+
90+
parsnip:::get_from_env("boost_tree_predict") |>
91+
dplyr::filter(stringr::(str_starts(engine, "h2o"))) |>
92+
dplyr::select(mode, type)
93+
94+
```
95+
8596
## Initializing h2o
8697

8798
```{r}

0 commit comments

Comments
 (0)