Skip to content

Commit f42bd2a

Browse files
committed
update readme
1 parent d6d3559 commit f42bd2a

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Pkg.add("MLJTestIntegration")
1515

1616
# Usage
1717

18-
This package provides a single method for testing a collection of
19-
`models` (types or named tuples with keys `:name` and `:package_name`)
20-
using the specified training `data`:
18+
This package provides a method for testing a collection of `models`
19+
(types or named tuples with keys `:name` and `:package_name`) using
20+
the specified training `data`:
2121

2222
```julia
2323
MLJTestIntegration.test(models, data...; mod=Main, level=2, throw=false, verbosity=1)
@@ -26,6 +26,16 @@ MLJTestIntegration.test(models, data...; mod=Main, level=2, throw=false, verbosi
2626

2727
For detailed documentation, run `using MLJTestIntegration; @doc MLJTestIntegration.test`.
2828

29+
For convenience, a number of specializations of this method are also provided:
30+
31+
- `test_single_target_classifiers`
32+
- `test_single_target_regressors`
33+
- `test_single_target_count_regressors`
34+
- `test_continuous_table_transformers`
35+
36+
Query the document strings for details, or see
37+
[examples/bigtest/notebook.jl](examples/bigtest/notebook.jl).
38+
2939

3040
# Examples
3141

0 commit comments

Comments
 (0)