Skip to content

For a 0.1.2 release #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 24, 2025
Merged

For a 0.1.2 release #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c3e794b
Improve doc-string
ablaom Aug 22, 2025
9672fa5
bump compat MLJModels = "0.18"; bump version 0.1.2
ablaom Sep 23, 2025
19af491
improve a docstring
ablaom Sep 23, 2025
8d553f4
another doc string improvement
ablaom Sep 23, 2025
ff4d4da
fix typo
ablaom Sep 24, 2025
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
4 changes: 2 additions & 2 deletions Project.toml
View file
Open in desktop
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.1"
version = "0.1.2"

[deps]
Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
Expand All @@ -15,7 +15,7 @@ Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb"
Distributed = "1"
InteractiveUtils = "1"
MLJModelInterface = "1.12"
MLJModels = "0.17"
MLJModels = "0.18"
OrderedCollections = "1.8"
Pkg = "1"
Random = "1"
Expand Down
12 changes: 10 additions & 2 deletions src/MLJModelRegistryTools.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@

Module providing tools for managing the MLJ Model Registry. To modify the registry:

- Make sure the MLJModelRegistryTools.jl `[compat]` entry for MLJModels is up to date. If
not you will need to update it. (Generally you cannot update the model registry and make
breaking releases of MLJModels at the same time. If this is absolutely necessary, you
will need to locally `dev` both packages.)

- Create a local clone of [MLJModels.jl](https://github.com/JuliaAI/MLJModels.jl), which
hosts the registry. After making changes, you will be making a MLJModels.jl pull
request.
Expand All @@ -16,9 +21,12 @@ Module providing tools for managing the MLJ Model Registry. To modify the regist

- Point the `MLJModelRegistryTools` module to the location of the registry itself within
your MLJModels.jl clone, using `setpath(path_to_registry)`, as in
`setpath("MyPkgs/MLJModels.jl/src/registry")`.
`setpath("MyPkgs/MLJModels.jl/src/registry")`. To check this worked, try
`MLJRegistryTools.get("MLJBase")`, to see the MLJBase.jl models.

- To add or update the metadata associated with a package, run [`update(pkg)`](@ref).
- To add or update the metadata associated with a package, run [`update(pkg)`](@ref), as
in `update("MLJTransforms"). Ensure that every model provided by the package appears as a
key in the returned value. Omissions may indicate a bad `load_path`.

- Assuming this is successful, update the metadata for *all* packages in the registry
by running [`update()`](@ref).
Expand Down
Loading