Skip to content

remove an incorrect statement in a docstring #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ablaom merged 2 commits into from
May 28, 2026
Merged

remove an incorrect statement in a docstring #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46385a3
remove an incorrect statement in a docstring
ablaom May 28, 2026
011006f
fix a wrong statement in the docs
ablaom May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/src/accessor_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# [Accessor Functions](@id accessor_functions)

The sole argument of an accessor function is the output, `model`, of
[`fit`](@ref). Learners are free to implement any number of these, or none of them. Only
`LearnAPI.strip` has a fallback, namely the identity.
The sole argument of an accessor function is the output, `model`, of [`fit`](@ref). The
only accessor function that must be implemented for each new learner is
[`LearnAPI.learner(model)`](@ref); [`LearnAPI.strip`](@ref) has a fallback, namely the
identity.

- [`LearnAPI.learner(model)`](@ref)
- [`LearnAPI.extras(model)`](@ref)
Expand Down
4 changes: 1 addition & 3 deletions src/predict_transform.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,7 @@ implementation must be added to the list returned by
`LearnAPI.kinds_of_proxy()`.

When `predict` is implemented, it may be necessary to overload
[`LearnAPI.features`](@ref). If `data` is not present in the implemented signature (eg.,
for density estimators) then [`LearnAPI.features(learner, data)`](@ref) must always return
`nothing`.
[`LearnAPI.features`](@ref).

$(DOC_IMPLEMENTED_METHODS(":(LearnAPI.predict)"))

Expand Down
Loading