Skip to content

Commit 47fe2b1

Browse files
committed
remove redundant doc constant
1 parent 6c633a1 commit 47fe2b1

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

src/traits.jl

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ const DOC_UNKNOWN =
66
"not overloaded the trait. "
77
const DOC_ON_TYPE = "The value of the trait must depend only on the type of `learner`. "
88

9-
const DOC_EXPLAIN_EACHOBS =
10-
"""
9+
# const DOC_EXPLAIN_EACHOBS =
10+
# """
1111

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)`".
1616

17-
"""
17+
# """
1818

1919
# # OVERLOADABLE TRAITS
2020

@@ -461,12 +461,17 @@ target variable associated with the learner. See LearnAPI.jl documentation for t
461461
of "target variable". See ScientificTypes.jl documentation for an explanation of the
462462
`scitype` function, which it provides.
463463
464-
Specifically, both of the following is always true:
464+
Specifically, both of the following are always true:
465465
466466
- 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)`".
470475
471476
- `S` is an upper bound on the `scitype` of (point) observations that might normally be
472477
extracted from the output of [`predict`](@ref).

0 commit comments

Comments
 (0)