1
- # MLJTest .jl
1
+ # MLJTestIntegration .jl
2
2
3
3
Package for applying integration tests to models implementing the
4
4
[ MLJ] ( https://alan-turing-institute.github.io/MLJ.jl/dev/ ) model
5
5
interface.
6
6
7
- [ ![ 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/MLJTest .jl/workflows/CI/badge.svg )] ( https://github.com/JuliaAI/MLJTest .jl/actions ) [ ![ Coverage] ( https://codecov.io/gh/JuliaAI/MLJTest .jl/branch/master/graph/badge.svg )] ( https://codecov.io/github/JuliaAI/MLJTest .jl?branch=master )
7
+ [ ![ 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 )
8
8
9
9
# Installation
10
10
11
11
``` julia
12
12
using Pkg
13
- Pkg. add (" MLJTest " )
13
+ Pkg. add (" MLJTestIntegration " )
14
14
```
15
15
16
16
# Usage
@@ -20,11 +20,11 @@ This package provides a single method for testing a collection of
20
20
using the specified training ` data ` :
21
21
22
22
``` julia
23
- MLJTest . test (models, data... ; mod= Main, level= 2 , throw= false , verbosity= 1 )
23
+ MLJTestIntegration . test (models, data... ; mod= Main, level= 2 , throw= false , verbosity= 1 )
24
24
-> failures, summary
25
25
```
26
26
27
- For detailed documentation, run ` using MLJTest ; @doc MLJTest .test ` .
27
+ For detailed documentation, run ` using MLJTestIntegration ; @doc MLJTestIntegration .test ` .
28
28
29
29
30
30
# Examples
@@ -36,10 +36,10 @@ The following tests the model interface implemented by some model type
36
36
type:
37
37
38
38
``` julia
39
- import MLJTest
39
+ import MLJTestIntegration
40
40
using Test
41
- X, y = MLJTest . MLJ. make_blobs ()
42
- failures, summary = MLJTest . test ([MyClassifier, ], X, y, verbosity= 1 , mod= @__MODULE__ )
41
+ X, y = MLJTestIntegration . MLJ. make_blobs ()
42
+ failures, summary = MLJTestIntegration . test ([MyClassifier, ], X, y, verbosity= 1 , mod= @__MODULE__ )
43
43
@test isempty (failures)
44
44
```
45
45
@@ -52,19 +52,19 @@ package `MLJGLMInterface`, this must be in the current environment:
52
52
53
53
``` julia
54
54
Pkg. add (" MLJGLMInterface" )
55
- import MLJBase, MLJTest
55
+ import MLJBase, MLJTestIntegration
56
56
using DataFrames # to view summary
57
- X, y = MLJTest . MLJ. make_regression ();
58
- regressors = MLJTest . MLJ. models (matching (X, y)) do m
57
+ X, y = MLJTestIntegration . MLJ. make_regression ();
58
+ regressors = MLJTestIntegration . MLJ. models (matching (X, y)) do m
59
59
m. package_name == " GLM"
60
60
end
61
61
62
62
# to test code loading *and* load code:
63
- MLJTest . test (regressors, X, y, verbosity= 1 , mod= @__MODULE__ , level= 1 )
63
+ MLJTestIntegration . test (regressors, X, y, verbosity= 1 , mod= @__MODULE__ , level= 1 )
64
64
65
65
# comprehensive tests:
66
66
failures, summary =
67
- MLJTest . test (regressors, X, y, verbosity= 3 , mod= @__MODULE__ , level= 1 )
67
+ MLJTestIntegration . test (regressors, X, y, verbosity= 3 , mod= @__MODULE__ , level= 1 )
68
68
69
69
summary |> DataFrame
70
70
```
0 commit comments