|
2 | 2 |
|
3 | 3 | Testing is provided by the LearnTestAPI.jl package. |
4 | 4 |
|
5 | | -<!-- Testing is provided by the LearnTestAPI.jl package documented below. --> |
| 5 | +Testing is provided by the LearnTestAPI.jl package documented below. |
6 | 6 |
|
7 | | -<!-- ## Quick start --> |
| 7 | +## Quick start |
8 | 8 |
|
9 | | -<!-- ```@docs --> |
10 | | -<!-- LearnTestAPI --> |
11 | | -<!-- ``` --> |
| 9 | +```@docs |
| 10 | +LearnTestAPI |
| 11 | +``` |
12 | 12 |
|
13 | | -<!-- !!! warning --> |
| 13 | +!!! warning |
14 | 14 |
|
15 | | -<!-- New releases of LearnTestAPI.jl may add tests to `@testapi`, and --> |
16 | | -<!-- this may result in new failures in client package test suites, because --> |
17 | | -<!-- of previously undetected broken contracts. Adding a test to `@testapi` --> |
18 | | -<!-- is not considered a breaking change --> |
19 | | -<!-- to LearnTestAPI, unless it supports a breaking change to LearnAPI.jl. --> |
| 15 | + New releases of LearnTestAPI.jl may add tests to `@testapi`, and |
| 16 | + this may result in new failures in client package test suites, because |
| 17 | + of previously undetected broken contracts. Adding a test to `@testapi` |
| 18 | + is not considered a breaking change |
| 19 | + to LearnTestAPI, unless it supports a breaking change to LearnAPI.jl. |
20 | 20 |
|
21 | 21 |
|
22 | | -<!-- ## The @testapi macro --> |
| 22 | +## The @testapi macro |
23 | 23 |
|
24 | | -<!-- ```@docs --> |
25 | | -<!-- LearnTestAPI.@testapi --> |
26 | | -<!-- ``` --> |
| 24 | +```@docs |
| 25 | +LearnTestAPI.@testapi |
| 26 | +``` |
27 | 27 |
|
28 | | -<!-- ## Learners for testing --> |
| 28 | +## Learners for testing |
29 | 29 |
|
30 | | -<!-- LearnTestAPI.jl provides some simple, tested, LearnAPI.jl implementations, which may be --> |
31 | | -<!-- useful for testing learner wrappers and meta-algorithms. --> |
| 30 | +LearnTestAPI.jl provides some simple, tested, LearnAPI.jl implementations, which may be |
| 31 | +useful for testing learner wrappers and meta-algorithms. |
32 | 32 |
|
33 | | -<!-- ```@docs --> |
34 | | -<!-- LearnTestAPI.Ridge --> |
35 | | -<!-- LearnTestAPI.BabyRidge --> |
36 | | -<!-- LearnTestAPI.ConstantClassifier --> |
37 | | -<!-- LearnTestAPI.TruncatedSVD --> |
38 | | -<!-- LearnTestAPI.Selector --> |
39 | | -<!-- LearnTestAPI.FancySelector --> |
40 | | -<!-- LearnTestAPI.NormalEstimator --> |
41 | | -<!-- LearnTestAPI.Ensemble --> |
42 | | -<!-- LearnTestAPI.StumpRegressor --> |
43 | | -<!-- ``` --> |
| 33 | +```@docs |
| 34 | +LearnTestAPI.Ridge |
| 35 | +LearnTestAPI.BabyRidge |
| 36 | +LearnTestAPI.ConstantClassifier |
| 37 | +LearnTestAPI.TruncatedSVD |
| 38 | +LearnTestAPI.Selector |
| 39 | +LearnTestAPI.FancySelector |
| 40 | +LearnTestAPI.NormalEstimator |
| 41 | +LearnTestAPI.Ensemble |
| 42 | +LearnTestAPI.StumpRegressor |
| 43 | +``` |
44 | 44 |
|
45 | | -<!-- ## Private methods --> |
| 45 | +## Private methods |
46 | 46 |
|
47 | | -<!-- For LearnTestAPI.jl developers only, and subject to breaking changes at any time: --> |
| 47 | +For LearnTestAPI.jl developers only, and subject to breaking changes at any time: |
48 | 48 |
|
49 | | -<!-- ```@docs --> |
50 | | -<!-- LearnTestAPI.@logged_testset --> |
51 | | -<!-- LearnTestAPI.@nearly --> |
52 | | -<!-- LearnTestAPI.isnear --> |
53 | | -<!-- LearnTestAPI.learner_get --> |
54 | | -<!-- LearnTestAPI.model_get --> |
55 | | -<!-- LearnTestAPI.verb --> |
56 | | -<!-- LearnTestAPI.filter_out_verbosity --> |
57 | | -<!-- ``` --> |
| 49 | +```@docs |
| 50 | +LearnTestAPI.@logged_testset |
| 51 | +LearnTestAPI.@nearly |
| 52 | +LearnTestAPI.isnear |
| 53 | +LearnTestAPI.learner_get |
| 54 | +LearnTestAPI.model_get |
| 55 | +LearnTestAPI.verb |
| 56 | +LearnTestAPI.filter_out_verbosity |
| 57 | +``` |
0 commit comments