Skip to content

Commit 0b6da1f

Browse files
committed
update name change in readme
1 parent 886c32e commit 0b6da1f

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# MLJTest.jl
1+
# MLJTestIntegration.jl
22

33
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-
[![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)
88

99
# Installation
1010

1111
```julia
1212
using Pkg
13-
Pkg.add("MLJTest")
13+
Pkg.add("MLJTestIntegration")
1414
```
1515

1616
# Usage
@@ -20,11 +20,11 @@ This package provides a single method for testing a collection of
2020
using the specified training `data`:
2121

2222
```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)
2424
-> failures, summary
2525
```
2626

27-
For detailed documentation, run `using MLJTest; @doc MLJTest.test`.
27+
For detailed documentation, run `using MLJTestIntegration; @doc MLJTestIntegration.test`.
2828

2929

3030
# Examples
@@ -36,10 +36,10 @@ The following tests the model interface implemented by some model type
3636
type:
3737

3838
```julia
39-
import MLJTest
39+
import MLJTestIntegration
4040
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__)
4343
@test isempty(failures)
4444
```
4545

@@ -52,19 +52,19 @@ package `MLJGLMInterface`, this must be in the current environment:
5252

5353
```julia
5454
Pkg.add("MLJGLMInterface")
55-
import MLJBase, MLJTest
55+
import MLJBase, MLJTestIntegration
5656
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
5959
m.package_name == "GLM"
6060
end
6161

6262
# 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)
6464

6565
# comprehensive tests:
6666
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)
6868

6969
summary |> DataFrame
7070
```

0 commit comments

Comments
 (0)