Skip to content

Commit 01245ba

Browse files
committed
use "learner" instead of "algorithm"
1 parent 04fc5c0 commit 01245ba

26 files changed

+639
-623
lines changed

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ makedocs(
2121
"target/weights/features" => "target_weights_features.md",
2222
"obs" => "obs.md",
2323
"Accessor Functions" => "accessor_functions.md",
24-
"Algorithm Traits" => "traits.md",
24+
"Learner Traits" => "traits.md",
2525
],
2626
"Common Implementation Patterns" => "common_implementation_patterns.md",
2727
"Testing an Implementation" => "testing_an_implementation.md",

docs/src/accessor_functions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# [Accessor Functions](@id accessor_functions)
22

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

7-
- [`LearnAPI.algorithm(model)`](@ref)
7+
- [`LearnAPI.learner(model)`](@ref)
88
- [`LearnAPI.extras(model)`](@ref)
99
- [`LearnAPI.strip(model)`](@ref)
1010
- [`LearnAPI.coefficients(model)`](@ref)
@@ -18,20 +18,20 @@ The sole argument of an accessor function is the output, `model`, of
1818
- [`LearnAPI.training_scores(model)`](@ref)
1919
- [`LearnAPI.components(model)`](@ref)
2020

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

2424
## Implementation guide
2525

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

3030

3131
## Reference
3232

3333
```@docs
34-
LearnAPI.algorithm
34+
LearnAPI.learner
3535
LearnAPI.extras
3636
LearnAPI.strip
3737
LearnAPI.coefficients

0 commit comments

Comments
 (0)