Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/SpellCheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 6 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "MLJModelRegistryTools"
uuid = "0a96183e-380b-4aa6-be10-c555140810f2"
authors = ["Anthony D. Blaom <[email protected]>"]
version = "0.1.3"
version = "0.1.4"

[deps]
Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
Expand Down
2 changes: 2 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ MLJModelRegistryTools = "0a96183e-380b-4aa6-be10-c555140810f2"

[compat]
Documenter = "1"
DocumenterInterLinks = "1.1.0"
MLJModelRegistryTools = "0.1.3"
julia = "1.10"
16 changes: 15 additions & 1 deletion src/MLJModelRegistryTools.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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=[<julia-wrapping-python packages>])` and
`update("PyPkg", manifest=false)`, for each julia-python package "PyPkg".

"""
module MLJModelRegistryTools

Expand Down
2 changes: 1 addition & 1 deletion src/methods.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading