Skip to content

Commit 81838e1

Browse files
committed
knit_engine_docs
1 parent f277699 commit 81838e1

7 files changed

+28
-14
lines changed

man/rmd/linear_reg_spark.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ This model has 2 tuning parameters:
1313

1414
- `mixture`: Proportion of Lasso Penalty (type: double, default: 0.0)
1515

16-
For `penalty`, the amount of regularization includes both the L1 penalty (i.e., lasso) and the L2 penalty (i.e., ridge or weight decay).
16+
For `penalty`, the amount of regularization includes both the L1 penalty (i.e., lasso) and the L2 penalty (i.e., ridge or weight decay). As for `mixture`:
1717

18-
A value of `mixture = 1` corresponds to a pure lasso model, while `mixture = 0` indicates ridge regression.
18+
* `mixture = 1` specifies a pure lasso model,
19+
* `mixture = 0` specifies a ridge regression model, and
20+
* `0 < mixture < 1` specifies an elastic net model, interpolating lasso and ridge.
1921

2022
## Translation from parsnip to the original package
2123

man/rmd/logistic_reg_glmnet.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ This model has 2 tuning parameters:
1313

1414
- `mixture`: Proportion of Lasso Penalty (type: double, default: 1.0)
1515

16-
A value of `mixture = 1` corresponds to a pure lasso model, while `mixture = 0` indicates ridge regression.
16+
The `penalty` parameter has no default and requires a single numeric value. For more details about this, and the `glmnet` model in general, see [glmnet-details]. As for `mixture`:
1717

18-
The `penalty` parameter has no default and requires a single numeric value. For more details about this, and the `glmnet` model in general, see [glmnet-details].
18+
* `mixture = 1` specifies a pure lasso model,
19+
* `mixture = 0` specifies a ridge regression model, and
20+
* `0 < mixture < 1` specifies an elastic net model, interpolating lasso and ridge.
1921

2022
## Translation from parsnip to the original package
2123

man/rmd/logistic_reg_spark.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ This model has 2 tuning parameters:
1313

1414
- `mixture`: Proportion of Lasso Penalty (type: double, default: 0.0)
1515

16-
For `penalty`, the amount of regularization includes both the L1 penalty (i.e., lasso) and the L2 penalty (i.e., ridge or weight decay).
16+
For `penalty`, the amount of regularization includes both the L1 penalty (i.e., lasso) and the L2 penalty (i.e., ridge or weight decay). As for `mixture`:
1717

18-
A value of `mixture = 1` corresponds to a pure lasso model, while `mixture = 0` indicates ridge regression.
18+
* `mixture = 1` specifies a pure lasso model,
19+
* `mixture = 0` specifies a ridge regression model, and
20+
* `0 < mixture < 1` specifies an elastic net model, interpolating lasso and ridge.
1921

2022
## Translation from parsnip to the original package
2123

man/rmd/multinom_reg_glmnet.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ This model has 2 tuning parameters:
1313

1414
- `mixture`: Proportion of Lasso Penalty (type: double, default: 1.0)
1515

16-
A value of `mixture = 1` corresponds to a pure lasso model, while `mixture = 0` indicates ridge regression.
16+
The `penalty` parameter has no default and requires a single numeric value. For more details about this, and the `glmnet` model in general, see [glmnet-details]. As for `mixture`:
1717

18-
The `penalty` parameter has no default and requires a single numeric value. For more details about this, and the `glmnet` model in general, see [glmnet-details].
18+
* `mixture = 1` specifies a pure lasso model,
19+
* `mixture = 0` specifies a ridge regression model, and
20+
* `0 < mixture < 1` specifies an elastic net model, interpolating lasso and ridge.
1921

2022
## Translation from parsnip to the original package
2123

man/rmd/multinom_reg_spark.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ This model has 2 tuning parameters:
1313

1414
- `mixture`: Proportion of Lasso Penalty (type: double, default: 0.0)
1515

16-
For `penalty`, the amount of regularization includes both the L1 penalty (i.e., lasso) and the L2 penalty (i.e., ridge or weight decay).
16+
For `penalty`, the amount of regularization includes both the L1 penalty (i.e., lasso) and the L2 penalty (i.e., ridge or weight decay). As for `mixture`:
1717

18-
A value of `mixture = 1` corresponds to a pure lasso model, while `mixture = 0` indicates ridge regression.
18+
* `mixture = 1` specifies a pure lasso model,
19+
* `mixture = 0` specifies a ridge regression model, and
20+
* `0 < mixture < 1` specifies an elastic net model, interpolating lasso and ridge.
1921

2022
## Translation from parsnip to the original package
2123

man/rmd/poisson_reg_glmnet.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ This model has 2 tuning parameters:
1313

1414
- `mixture`: Proportion of Lasso Penalty (type: double, default: 1.0)
1515

16-
A value of `mixture = 1` corresponds to a pure lasso model, while `mixture = 0` indicates ridge regression.
16+
The `penalty` parameter has no default and requires a single numeric value. For more details about this, and the `glmnet` model in general, see [glmnet-details]. As for `mixture`:
1717

18-
The `penalty` parameter has no default and requires a single numeric value. For more details about this, and the `glmnet` model in general, see [glmnet-details].
18+
* `mixture = 1` specifies a pure lasso model,
19+
* `mixture = 0` specifies a ridge regression model, and
20+
* `0 < mixture < 1` specifies an elastic net model, interpolating lasso and ridge.
1921

2022
## Translation from parsnip to the original package
2123

man/rmd/proportional_hazards_glmnet.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ This model has 2 tuning parameters:
1313

1414
- `mixture`: Proportion of Lasso Penalty (type: double, default: 1.0)
1515

16-
A value of `mixture = 1` corresponds to a pure lasso model, while `mixture = 0` indicates ridge regression.
16+
The `penalty` parameter has no default and requires a single numeric value. For more details about this, and the `glmnet` model in general, see [parsnip::glmnet-details]. As for `mixture`:
1717

18-
The `penalty` parameter has no default and requires a single numeric value. For more details about this, and the `glmnet` model in general, see [parsnip::glmnet-details].
18+
* `mixture = 1` specifies a pure lasso model,
19+
* `mixture = 0` specifies a ridge regression model, and
20+
* `0 < mixture < 1` specifies an elastic net model, interpolating lasso and ridge.
1921

2022
## Translation from parsnip to the original package
2123

0 commit comments

Comments
 (0)