From d6cd610d2d751d5067d63811170729d71db1ee48 Mon Sep 17 00:00:00 2001 From: "Anthony D. Blaom" Date: Sat, 2 Nov 2024 17:22:03 +1300 Subject: [PATCH] tweak docs --- docs/src/obs.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/src/obs.md b/docs/src/obs.md index 5d81012..da6b2cc 100644 --- a/docs/src/obs.md +++ b/docs/src/obs.md @@ -2,13 +2,14 @@ The `obs` method takes data intended as input to `fit`, `predict` or `transform`, and transforms it to a learner-specific form guaranteed to implement a form of observation -access designated by the learner. The transformed data can then be resampled and passed -on to the relevant method in place of the original input. Using `obs` may provide -performance advantages over naive workflows in some cases (e.g., cross-validation). +access designated by the learner. The transformed data can then passed on to the relevant +method in place of the original input (after first resampling it, if the learner supports +this). Using `obs` may provide performance advantages over naive workflows in some cases +(e.g., cross-validation). ```julia obs(learner, data) # can be passed to `fit` instead of `data` -obs(model, data) # can be passed to `predict` or `transform` instead of `data` +obs(model, data) # can be passed to `predict` or `transform` instead of `data` ``` ## [Typical workflows](@id obs_workflows)