diff --git a/.github/workflows/SpellCheck.yml b/.github/workflows/SpellCheck.yml index 3d62423..6e95f78 100644 --- a/.github/workflows/SpellCheck.yml +++ b/.github/workflows/SpellCheck.yml @@ -8,6 +8,6 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Actions Repository - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Check spelling uses: crate-ci/typos@master \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 474dd2f..5870ebb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,12 +24,12 @@ jobs: arch: - x64 steps: - - uses: actions/checkout@v2 - - uses: julia-actions/setup-julia@v1 + - uses: actions/checkout@v6 + - uses: julia-actions/setup-julia@v2 with: version: ${{ matrix.version }} arch: ${{ matrix.arch }} - - uses: julia-actions/cache@v1 + - uses: julia-actions/cache@v3 env: cache-name: cache-artifacts with: @@ -44,7 +44,7 @@ jobs: env: JULIA_NUM_THREADS: 2 - uses: julia-actions/julia-processcoverage@v1 - - uses: codecov/codecov-action@v4 + - uses: codecov/codecov-action@v6 with: token: ${{ secrets.CODECOV_TOKEN }} fail_ci_if_error: false @@ -53,8 +53,8 @@ jobs: name: Documentation runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: julia-actions/setup-julia@v1 + - uses: actions/checkout@v6 + - uses: julia-actions/setup-julia@v2 with: version: '1' - uses: julia-actions/julia-buildpkg@v1 diff --git a/Project.toml b/Project.toml index 7f800ee..5e7aa7c 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "MLJModelRegistryTools" uuid = "0a96183e-380b-4aa6-be10-c555140810f2" authors = ["Anthony D. Blaom "] -version = "0.1.3" +version = "0.1.4" [deps] Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b" diff --git a/docs/Project.toml b/docs/Project.toml index 8817a75..8a621b7 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -5,4 +5,6 @@ MLJModelRegistryTools = "0a96183e-380b-4aa6-be10-c555140810f2" [compat] Documenter = "1" +DocumenterInterLinks = "1.1.0" +MLJModelRegistryTools = "0.1.3" julia = "1.10" diff --git a/src/MLJModelRegistryTools.jl b/src/MLJModelRegistryTools.jl index 502d962..3c56d34 100644 --- a/src/MLJModelRegistryTools.jl +++ b/src/MLJModelRegistryTools.jl @@ -3,7 +3,8 @@ !!! note - Issues around packages in the MLJ model registry that use PythonCall necessitate `update` workarounds. See [https://github.com/JuliaAI/MLJModelRegistryTools.jl/issues/10](https://github.com/JuliaAI/MLJModelRegistryTools.jl/issues/10). + If a model-providing package has compat bounds that are blocking other packages from + loading with latest versions, see the "Hacks" section below for a workaround. Module providing tools for managing the MLJ Model Registry. To modify the registry: @@ -66,6 +67,19 @@ register the new models may be rejected. [`MLJModelRegistryTools.gc()`](@ref)) the metadata for all orphaned packages is removed. +# Hacks + +By default, the `update` command instantiates the project pointed to by `setpath` and uses +the resulting Manifest.toml file to determine versions of the model-providing packages for +which metadata is to be updated. If a particular package, "MyPkg" say, is blocking latest +versions of the others, you can temporarily remove it from the project, run `update()`, +return "MyPkg" to the project and run `update("MyPkg", manifest=false)` to update the +metadata for the latest "MyPkg". + +If python compatibilities are the issue, you can leave the julia-wrapping-python packages +in the project, but run `update(skip=[])` and +`update("PyPkg", manifest=false)`, for each julia-python package "PyPkg". + """ module MLJModelRegistryTools diff --git a/src/methods.jl b/src/methods.jl index 6846f19..d53e049 100644 --- a/src/methods.jl +++ b/src/methods.jl @@ -62,7 +62,7 @@ Extract the metadata for a package. Returns a `Future` object that must be `fetc get the metadata. See, [`MLJModelRegistryTools.update`](@ref), which calls this method, for more details. -Assumes that MLJModelRegistryTools has been `develop`ed into `registry` if this is non-empty. +Assumes that MLJModelRegistryTools has been `add`ed into `registry` if this is non-empty. """ function metadata(pkg; registry="", check_traits=true)