Merge pull request #38 from JuliaAI/learners

Use "learner" instead of "algorithm" in docs and in variable names

Author: ablaom

Project.toml

@@ -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"
 

docs/make.jl

@@ -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",

docs/src/accessor_functions.md

@@ -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)
@@ -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