Skip to content

Commit

Permalink
tweak docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ablaom committed Nov 2, 2024
1 parent 1647461 commit d6cd610
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/src/obs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit d6cd610

Please sign in to comment.