@@ -6,15 +6,15 @@ const DOC_UNKNOWN =
6
6
" not overloaded the trait. "
7
7
const DOC_ON_TYPE = " The value of the trait must depend only on the type of `learner`. "
8
8
9
- const DOC_EXPLAIN_EACHOBS =
10
- """
9
+ # const DOC_EXPLAIN_EACHOBS =
10
+ # """
11
11
12
- Here, "for each `o` in `observations`" is understood in the sense of
13
- [`LearnAPI.data_interface(learner)`](@ref). For example, if
14
- `LearnAPI.data_interface(learner) == Base.HasLength ()`, then this means "for `o` in
15
- `MLUtils.eachobs(observations)`".
12
+ # Here, "for each `o` in `observations`" is understood in the sense of the data
13
+ # interface specified for the learner, [`LearnAPI.data_interface(learner)`](@ref). For
14
+ # example, if this is `LearnAPI.RandomAccess ()`, then this means "for `o` in
15
+ # `MLUtils.eachobs(observations)`".
16
16
17
- """
17
+ # """
18
18
19
19
# # OVERLOADABLE TRAITS
20
20
@@ -461,12 +461,17 @@ target variable associated with the learner. See LearnAPI.jl documentation for t
461
461
of "target variable". See ScientificTypes.jl documentation for an explanation of the
462
462
`scitype` function, which it provides.
463
463
464
- Specifically, both of the following is always true:
464
+ Specifically, both of the following are always true:
465
465
466
466
- If `:(LearnAPI.target) in LearnAPI.functions(learner)` (i.e., `fit` consumes target
467
- variables) then "target" means anything returned by [`LearnAPI.target(learner,
468
- observations)`](@ref), where `observations = `[`LearnAPI.obs(learner, data)`](@ref) and
469
- `data` is a supported argument in the call [`fit(learner, data)`](@ref).
467
+ variables) then `ScientificTypes.scitype(o) <: S` for each `o` in `target_observations`,
468
+ where `target_observations = `[`LearnAPI.target(learner, observations)`](@ref),
469
+ `observations = `[`LearnAPI.obs(learner, data)`](@ref), and `data` is a supported
470
+ argument in the call [`fit(learner, data)`](@ref). Here, "for each `o` in
471
+ `target_observations`" is understood in the sense of the data interface specified for
472
+ the learner, [`LearnAPI.data_interface(learner)`](@ref). For example, if this is
473
+ `LearnAPI.RandomAccess()`, then this means "for each `o in
474
+ MLUtils.eachobs(target_observations)`".
470
475
471
476
- `S` is an upper bound on the `scitype` of (point) observations that might normally be
472
477
extracted from the output of [`predict`](@ref).
0 commit comments