From c3e794be024f7c1c666b8e902a16dbeccde205cf Mon Sep 17 00:00:00 2001 From: "Anthony D. Blaom" Date: Fri, 22 Aug 2025 14:07:47 +1200 Subject: [PATCH 1/5] Improve doc-string --- src/MLJModelRegistryTools.jl | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/MLJModelRegistryTools.jl b/src/MLJModelRegistryTools.jl index d92ce42..fd9d9d2 100644 --- a/src/MLJModelRegistryTools.jl +++ b/src/MLJModelRegistryTools.jl @@ -18,7 +18,9 @@ Module providing tools for managing the MLJ Model Registry. To modify the regist your MLJModels.jl clone, using `setpath(path_to_registry)`, as in `setpath("MyPkgs/MLJModels.jl/src/registry")`. -- 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). Ensure that every model provided by the packge 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). From 9672fa566504ac6bea0b7b2ac31866b282c2a54e Mon Sep 17 00:00:00 2001 From: "Anthony D. Blaom" Date: Wed, 24 Sep 2025 10:49:14 +1200 Subject: [PATCH 2/5] bump compat MLJModels = "0.18"; bump version 0.1.2 --- Project.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Project.toml b/Project.toml index 9bf5739..03726c3 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.1" +version = "0.1.2" [deps] Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b" @@ -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" From 19af4914d94222a6a435a2b06ec86def6c6e884e Mon Sep 17 00:00:00 2001 From: "Anthony D. Blaom" Date: Wed, 24 Sep 2025 10:51:33 +1200 Subject: [PATCH 3/5] improve a docstring --- src/MLJModelRegistryTools.jl | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/MLJModelRegistryTools.jl b/src/MLJModelRegistryTools.jl index fd9d9d2..656ce5c 100644 --- a/src/MLJModelRegistryTools.jl +++ b/src/MLJModelRegistryTools.jl @@ -16,11 +16,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). Ensure that every model provided by the packge appears as a key - in the returned value. Omissions may indicate a bad `load_path`. +- 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 packge 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). From 8d553f41c4468611f3f8548ed87aac944ce538da Mon Sep 17 00:00:00 2001 From: "Anthony D. Blaom" Date: Wed, 24 Sep 2025 10:59:33 +1200 Subject: [PATCH 4/5] another doc string improvement --- src/MLJModelRegistryTools.jl | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/MLJModelRegistryTools.jl b/src/MLJModelRegistryTools.jl index 656ce5c..e9d9108 100644 --- a/src/MLJModelRegistryTools.jl +++ b/src/MLJModelRegistryTools.jl @@ -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. From ff4d4dacb1d161dd75faa04bf8414bb5ffd059bd Mon Sep 17 00:00:00 2001 From: "Anthony D. Blaom" Date: Wed, 24 Sep 2025 12:54:30 +1200 Subject: [PATCH 5/5] fix typo --- src/MLJModelRegistryTools.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/MLJModelRegistryTools.jl b/src/MLJModelRegistryTools.jl index e9d9108..ab5426c 100644 --- a/src/MLJModelRegistryTools.jl +++ b/src/MLJModelRegistryTools.jl @@ -25,7 +25,7 @@ Module providing tools for managing the MLJ Model Registry. To modify the regist `MLJRegistryTools.get("MLJBase")`, to see the MLJBase.jl models. - 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 packge appears as a + 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