Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 0 additions & 3 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ uuid = "92ad9a40-7767-427a-9ee6-6e577f1266cb"
authors = ["Anthony D. Blaom <[email protected]>"]
version = "0.1.0"

[deps]
InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"

[compat]
julia = "1.6"

Expand Down
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ makedocs(
"target/weights/features" => "target_weights_features.md",
"obs" => "obs.md",
"Accessor Functions" => "accessor_functions.md",
"Algorithm Traits" => "traits.md",
"Learner Traits" => "traits.md",
],
"Common Implementation Patterns" => "common_implementation_patterns.md",
"Testing an Implementation" => "testing_an_implementation.md",
Expand Down
12 changes: 6 additions & 6 deletions docs/src/accessor_functions.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# [Accessor Functions](@id accessor_functions)

The sole argument of an accessor function is the output, `model`, of
[`fit`](@ref). Algorithms are free to implement any number of these, or none of them. Only
[`fit`](@ref). Learners are free to implement any number of these, or none of them. Only
`LearnAPI.strip` has a fallback, namely the identity.

- [`LearnAPI.algorithm(model)`](@ref)
- [`LearnAPI.learner(model)`](@ref)
- [`LearnAPI.extras(model)`](@ref)
- [`LearnAPI.strip(model)`](@ref)
- [`LearnAPI.coefficients(model)`](@ref)
Expand All @@ -18,20 +18,20 @@ The sole argument of an accessor function is the output, `model`, of
- [`LearnAPI.training_scores(model)`](@ref)
- [`LearnAPI.components(model)`](@ref)

Algorithm-specific accessor functions may also be implemented. The names of all accessor
functions are included in the list returned by [`LearnAPI.functions(algorithm)`](@ref).
Learner-specific accessor functions may also be implemented. The names of all accessor
functions are included in the list returned by [`LearnAPI.functions(learner)`](@ref).

## Implementation guide

All new implementations must implement [`LearnAPI.algorithm`](@ref). While, all others are
All new implementations must implement [`LearnAPI.learner`](@ref). While, all others are
optional, any implemented accessor functions must be added to the list returned by
[`LearnAPI.functions`](@ref).


## Reference

```@docs
LearnAPI.algorithm
LearnAPI.learner
LearnAPI.extras
LearnAPI.strip
LearnAPI.coefficients
Expand Down
Loading
Loading