Skip to content

Commit ca4c9a4

Browse files
committed
update readme
1 parent 9497860 commit ca4c9a4

File tree

1 file changed

+4
-16
lines changed

1 file changed

+4
-16
lines changed

README.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ Package for applying integration tests to models implementing the
44
[MLJ](https://alan-turing-institute.github.io/MLJ.jl/dev/) model
55
interface.
66

7+
**To test implementations of the MLJ model interface, use [MLJTestInterface.jl]()
8+
instead.**
9+
710
[![Lifecycle:Experimental](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md) [![Build Status](https://github.com/JuliaAI/MLJTestIntegration.jl/workflows/CI/badge.svg)](https://github.com/JuliaAI/MLJTestIntegration.jl/actions) [![Coverage](https://codecov.io/gh/JuliaAI/MLJTestIntegration.jl/branch/master/graph/badge.svg)](https://codecov.io/github/JuliaAI/MLJTestIntegration.jl?branch=master)
811

912
# Installation
@@ -37,22 +40,7 @@ Query the document strings for details, or see
3740
[examples/bigtest/notebook.jl](examples/bigtest/notebook.jl).
3841

3942

40-
# Examples
41-
42-
## Testing models in a new MLJ model interface implementation
43-
44-
The following tests the model interface implemented by some model type `MyClassifier` for
45-
multiclass classification, as might appear in tests for a package providing that type:
46-
47-
```julia
48-
import MLJTestIntegration
49-
using Test
50-
X, y = MLJTestIntegration.make_multiclass()
51-
failures, summary = MLJTestIntegration.test([MyClassifier, ], X, y, verbosity=1, mod=@__MODULE__)
52-
@test isempty(failures)
53-
```
54-
55-
## Testing models after filtering models in the registry
43+
# Example: Testing models filtered from the MLJ model registry
5644

5745
The following applies comprehensive integration tests to all
5846
regressors provided by the package GLM.jl appearing in the MLJ Model

0 commit comments

Comments
 (0)