Integrate documentation for LearnTestAPI

Author: ablaom

docs/Project.toml

@@ -2,6 +2,7 @@
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 LearnAPI = "92ad9a40-7767-427a-9ee6-6e577f1266cb"
+LearnTestAPI = "3111ed91-c4f2-40e7-bb19-7f6c618409b8"
 MLUtils = "f1d291b0-491e-4a28-83b9-f70985020b54"
 ScientificTypesBase = "30f210dd-8aff-4c5f-94ba-8e64358c1161"
 Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"

docs/make.jl

@@ -2,11 +2,12 @@ using Documenter
 using LearnAPI
 using ScientificTypesBase
 using DocumenterInterLinks
+using LearnTestAPI
 
 const  REPO = Remotes.GitHub("JuliaAI", "LearnAPI.jl")
 
 makedocs(
-    modules=[LearnAPI,],
+    modules=[LearnAPI, LearnTestAPI],
     format=Documenter.HTML(
         prettyurls = true,#get(ENV, "CI", nothing) == "true",
         collapselevel = 1,

docs/src/index.md

@@ -84,11 +84,13 @@ appear as an input to training but not to prediction.
 ## Data interfaces
 
 Algorithms are free to consume data in any format. However, a method called [`obs`](@ref
-data_interface) (read as "observations") gives users and meta-algorithms access to an
-algorithm-specific representation of input data, which is also guaranteed to implement a
-standard interface for accessing individual observations, unless the algorithm explicitly
-opts out. Moreover, the `fit` and `predict` methods will also be able to consume these
-alternative data representations, for performance benefits in some situations.
+data_interface) (read as "observations") gives developers the option of providing a
+separate data front end for their algorithms. In this case `obs` gives users and
+meta-algorithms access to an algorithm-specific representation of input data, which is
+also guaranteed to implement a standard interface for accessing individual observations,
+unless the algorithm explicitly opts out. Moreover, the `fit` and `predict` methods will
+also be able to consume these alternative data representations, for performance benefits
+in some situations.
 
 The fallback data interface is the [MLUtils.jl](https://github.com/JuliaML/MLUtils.jl)
 `getobs/numobs` interface, here tagged as [`LearnAPI.RandomAccess()`](@ref), and if the
@@ -97,6 +99,9 @@ then overloading `obs` is completely optional. Plain iteration interfaces, with
 knowledge of the number of observations, can also be specified, to support, e.g., data
 loaders reading images from disk.
 
+Some canned data front ends are provided by the
+[LearnDataFrontEnds.jl](https://juliaai.github.io/LearnAPI.jl/stable/) package.
+
 ## Learning more
 
 - [Anatomy of an Implementation](@ref): informal introduction to the main actors in a new

docs/src/testing_an_implementation.md

@@ -1,9 +1,55 @@
 # Testing an Implementation
 
-```@raw html
-🚧
+Testing is provided by the LearnTestAPI.jl package documented below. 
+
+## Quick start
+
+```@docs
+LearnTestAPI
 ```
 
+LearnAPI.jl and LearnTestAPI.jl have synchronized releases. For example, LearnTestAPI.jl
+version 0.2.3 will generally support all LearnAPI.jl versions 0.2.*.
+
 !!! warning
 
-    Under construction
+    New releases of LearnTestAPI.jl may add tests to `@testapi`, and this may result in
+    new failures in client package test suites. Nevertheless, adding a test to `@testapi`
+    is not considered a breaking change to LearnTestAPI, unless the addition supports a
+    breaking release of LearnAPI.jl.
+
+
+## The @testapi macro
+
+```@docs
+LearnTestAPI.@testapi
+```
+
+## Learners for testing
+
+LearnTestAPI.jl provides some simple, tested, LearnAPI.jl implementations, which may be
+useful for testing learner wrappers and meta-algorithms. 
+
+```@docs
+LearnTestAPI.Ridge
+LearnTestAPI.BabyRidge
+LearnTestAPI.TruncatedSVD
+LearnTestAPI.Selector
+LearnTestAPI.FancySelector
+LearnTestAPI.NormalEstimator
+LearnTestAPI.Ensemble
+```
+
+## Private methods
+
+For LearnTestAPI.jl developers only, and subject to breaking changes:
+
+```@docs
+LearnTestAPI.@logged_testset
+LearnTestAPI.@nearly
+LearnTestAPI.isnear
+LearnTestAPI.learner_get
+LearnTestAPI.model_get
+LearnTestAPI.verb
+LearnTestAPI.filter_out_verbosity
+```