@@ -464,21 +464,25 @@ fit_observation_type(::Any) = Union{}
464
464
"""
465
465
LearnAPI.target_observation_scitype(algorithm)
466
466
467
- Return an upper bound `S` on the scitype of each observation of `LearnAPI. target(data)`,
468
- where `data` is an admissible argument in the call `fit(algorithm, data)`.
467
+ Return an upper bound `S` on the scitype of each observation of an applicable target
468
+ variable. Specifically:
469
469
470
- This interpretation only holds if `LearnAPI.target(algorithm)` is `true`. In any case,
471
- however, if `algorithm` implements `predict`, then `S` will always be an
472
- upper bound on the scitype of observations that could be conceivably extracted from the
473
- output of [`predict`](@ref). For example, suppose we have
470
+ - If `:(LearnAPI.target) in LearnAPI.functions(algorithm)` (i.e., `fit` consumes target
471
+ variables) then "target" means anything returned by `LearnAPI.target(algorithm, data)`,
472
+ where `data` is an admissible argument in the call `fit(algorithm, data)`.
473
+
474
+ - `S` will always be an upper bound on the scitype of observations that could be
475
+ conceivably extracted from the output of [`predict`](@ref).
476
+
477
+ To illustate the second case, suppose we have
474
478
475
479
```julia
476
480
model = fit(algorithm, data)
477
481
ŷ = predict(model, Sampleable(), data_new)
478
482
```
479
483
480
- Then each sample generated by each "observation" of `ŷ` (a vector of sampleable objects,
481
- say) will be bound in scitype by `S`.
484
+ Then each individual sample generated by each "observation" of `ŷ` (a vector of sampleable
485
+ objects, say) will be bound in scitype by `S`.
482
486
483
487
See also See also [`LearnAPI.fit_observation_scitype`](@ref).
484
488
0 commit comments