Skip to content

Commit 1d3be8e

Browse files
committed
minor doc clarification
1 parent d21c403 commit 1d3be8e

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/traits.jl

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -440,16 +440,17 @@ fit_observation_scitype(::Any) = Union{}
440440
LearnAPI.target_observation_scitype(learner)
441441
442442
Return an upper bound `S` on the scitype of each observation of an applicable target
443-
variable. Specifically:
443+
variable. Specifically, both of the following is always true:
444444
445445
- If `:(LearnAPI.target) in LearnAPI.functions(learner)` (i.e., `fit` consumes target
446-
variables) then "target" means anything returned by `LearnAPI.target(learner, data)`,
447-
where `data` is an admissible argument in the call `fit(learner, data)`.
446+
variables) then "target" means anything returned by [`LearnAPI.target(learner,
447+
observations)`](@ref), where `observations = `[`LearnAPI.obs(learner, data)`](@ref) and
448+
`data` is an admissible argument in the call [`fit(learner, data)`](@ref).
448449
449450
- `S` will always be an upper bound on the scitype of (point) observations that could be
450451
conceivably extracted from the output of [`predict`](@ref).
451452
452-
To illustate the second case, suppose we have
453+
To illustate the second property, suppose we have
453454
454455
```julia
455456
model = fit(learner, data)

0 commit comments

Comments
 (0)