Skip to content

Commit 00f8ce5

Browse files
committed
model-specific layers
1 parent 06df10d commit 00f8ce5

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

vignettes/custom_epiworkflows.Rmd

+9-9
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ The post-processing `frosting` layers[^1] found in `four_week_ahead` look like:
227227
epipredict::extract_frosting(four_week_ahead$epi_workflow)
228228
```
229229

230-
Note: since `frosting` is unique to this package, we've defined a custom function `extract_frosting()` to inspect these steps.
230+
_Note_: since `frosting` is unique to this package, we've defined a custom function `extract_frosting()` to inspect these steps.
231231

232232
Using the detailed information in the output above,
233233
we can recreate the layers similar to how we defined the
@@ -245,10 +245,10 @@ four_week_layers <- frosting() |>
245245
`layer_predict()` needs to be included in every postprocessor to actually train the model.
246246

247247
Most layers work with any engine or `step`s.
248-
There are a couple of layers, however, which depend on whether the engine predicts quantiles or point estimates.
248+
There are a couple of layers, however, that depend on whether the engine predicts quantiles or point estimates.
249249

250-
The layers that are only supported by point estimate engines (such as
251-
`linear_reg()`) are:
250+
The following layers are only supported by point estimate engines, such as
251+
`linear_reg()`:
252252

253253
- `layer_residual_quantiles()`: the preferred method of generating quantiles for
254254
models that don't generate quantiles themselves.
@@ -260,14 +260,14 @@ The layers that are only supported by point estimate engines (such as
260260

261261
<!-- TODO check this -->
262262

263-
On the other hand, the layers that are only supported by quantile estimating
264-
engines (such as `quantile_reg()`) are
263+
On the other hand, the following layers are only supported by engines that
264+
output quantiles, such as `quantile_reg()`:
265265

266266
- `layer_quantile_distn()`: adds the specified quantiles.
267-
If the quantile levels specified differ from the ones actually fit, they will be interpolated and/or
267+
If the user-requested quantile levels differ from the ones actually fit, they will be interpolated and/or
268268
extrapolated.
269-
- `layer_point_from_distn()`: this adds the median quantile as a point estimate,
270-
and, if called, should be included after `layer_quantile_distn()`.
269+
- `layer_point_from_distn()`: this adds the middle quantile (median) as a point estimate,
270+
and, if used, should be included after `layer_quantile_distn()`.
271271

272272
## Fitting an `epi_workflow()`
273273

0 commit comments

Comments
 (0)