diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8cc5cea..f7c0ea8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -49,22 +49,3 @@ jobs: token: ${{ secrets.CODECOV_TOKEN }} fail_ci_if_error: false verbose: true - docs: - name: Documentation - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: julia-actions/setup-julia@v1 - with: - version: '1' - - uses: julia-actions/julia-buildpkg@v1 - - uses: julia-actions/julia-docdeploy@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} - - run: | - julia --project=docs -e ' - using Documenter: DocMeta, doctest - using LearnTestAPI - DocMeta.setdocmeta!(LearnTestAPI, :DocTestSetup, :(using LearnTestAPI); recursive=true) - doctest(LearnTestAPI)' diff --git a/Project.toml b/Project.toml index 65f52ff..3fc23cd 100644 --- a/Project.toml +++ b/Project.toml @@ -25,7 +25,7 @@ UnPack = "3a884ed6-31ef-47d7-9d2a-63182c4928ed" Distributions = "0.25" InteractiveUtils = "<0.0.1, 1" IsURL = "0.2.0" -LearnAPI = "0.1.0" +LearnAPI = "0.2.0" LinearAlgebra = "<0.0.1, 1" MLUtils = "0.4" Random = "<0.0.1, 1" diff --git a/README.md b/README.md index 144c795..4e1d46d 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,6 @@ Tool for testing implementations of the machine learning and statistics [![Build Status](https://github.com/JuliaAI/LearnTestAPI.jl/workflows/CI/badge.svg)](https://github.com/JuliaAI/LearnTestAPI.jl/actions) -[![codecov](https://codecov.io/gh/JuliaAI/LearnTestAPI.jl/graph/badge.svg?token=9IWT9KYINZ)] +[![codecov](https://codecov.io/gh/JuliaAI/LearnTestAPI.jl/graph/badge.svg?token=gCIQfDtzMt)](https://codecov.io/gh/JuliaAI/LearnTestAPI.jl) -See [LearnAPI.jl](https://juliaai.github.io/LearnAPI.jl/stable/) for documentation. +See [LearnAPI.jl](https://juliaai.github.io/LearnAPI.jl/stable/) for documentation. diff --git a/src/logging.jl b/src/logging.jl index 3e53a97..806837b 100644 --- a/src/logging.jl +++ b/src/logging.jl @@ -43,7 +43,7 @@ const FUNCTIONS3 = """ """ const FUNCTIONS4 = """ - Testing that `LearnAPI.functions(learner)` exludes `:(LearnAPI.features)`, as + Testing that `LearnAPI.functions(learner)` excludes `:(LearnAPI.features)`, as `LearnAPI.is_static(learner)` is `true`. """ @@ -410,7 +410,7 @@ const FIT_SCITYPE = """ """ const TARGET_OBSERVATION_SCITYPE = """ - Checking that `LearnAPI.target(learner, observatoins)` satisifies the constraints + Checking that `LearnAPI.target(learner, observatoins)` satisfies the constraints articulated by `LearnAPI.target_observation_scitype(learner)`. """ diff --git a/src/testapi.jl b/src/testapi.jl index f8ae311..11d9b3b 100644 --- a/src/testapi.jl +++ b/src/testapi.jl @@ -8,7 +8,7 @@ contracts against one or more data sets. using LearnTestAPI X = ( - feautre1 = [1, 2, 3], + feature1 = [1, 2, 3], feature2 = ["a", "b", "c"], feature3 = [10.0, 20.0, 30.0], ) diff --git a/src/tools.jl b/src/tools.jl index 1e8a0ff..c53a590 100644 --- a/src/tools.jl +++ b/src/tools.jl @@ -137,7 +137,7 @@ end *Private method.* -Replaces the expresion `lhs == rhs` with `isnear(lhs, rhs; kwargs...)` for testing a weaker +Replaces the expression `lhs == rhs` with `isnear(lhs, rhs; kwargs...)` for testing a weaker form of equality. Here `kwargs...` are keyword arguments accepted in `isapprox(lhs, rhs; kwargs...)`, which is called if `lhs == rhs` fails.