rename MLJModelRegistry -> MLJModelRegistryTools

Author: ablaom

Project.toml

@@ -1,4 +1,4 @@
-name = "MLJModelRegistry"
+name = "MLJModelRegistryTools"
 uuid = "0a96183e-380b-4aa6-be10-c555140810f2"
 authors = ["Anthony D. Blaom <[email protected]>"]
 version = "0.1.0"

README.md

@@ -1,13 +1,13 @@
-# MLJModelRegistry.jl
+# MLJModelRegistryTools.jl
 
 Home of the MLJ Model Registry and tools to maintain it
 
-[![Build Status](https://github.com/JuliaAI/MLJModelRegistry.jl/workflows/CI/badge.svg)](https://github.com/JuliaAI/MLJModelRegistry.jl/actions)
-[![codecov](https://codecov.io/gh/JuliaAI/MLJModelRegistry.jl/graph/badge.svg?token=9IWT9KYINZ)](https://codecov.io/gh/JuliaAI/MLJModelRegistry.jl?branch=dev)
-[![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaai.github.io/MLJModelRegistry.jl/dev/)
-[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaai.github.io/MLJModelRegistry.jl/stable/)
+[![Build Status](https://github.com/JuliaAI/MLJModelRegistryTools.jl/workflows/CI/badge.svg)](https://github.com/JuliaAI/MLJModelRegistryTools.jl/actions)
+[![codecov](https://codecov.io/gh/JuliaAI/MLJModelRegistryTools.jl/graph/badge.svg?token=9IWT9KYINZ)](https://codecov.io/gh/JuliaAI/MLJModelRegistryTools.jl?branch=dev)
+[![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaai.github.io/MLJModelRegistryTools.jl/dev/)
+[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaai.github.io/MLJModelRegistryTools.jl/stable/)
 
 What is this repository for? See
-[here](https://juliaai.github.io/MLJModelRegistry.jl/stable/#What's-this-repository-for?).
+[here](https://juliaai.github.io/MLJModelRegistryTools.jl/stable/#What's-this-repository-for?).
 
 

docs/Project.toml

@@ -1,7 +1,7 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
-MLJModelRegistry = "0a96183e-380b-4aa6-be10-c555140810f2"
+MLJModelRegistryTools = "0a96183e-380b-4aa6-be10-c555140810f2"
 
 [compat]
 Documenter = "1"

docs/make.jl

@@ -1,12 +1,12 @@
 using Documenter
-using MLJModelRegistry
+using MLJModelRegistryTools
 using DocumenterInterLinks
-using MLJModelRegistry.GenericRegistry
+using MLJModelRegistryTools.GenericRegistry
 
-const  REPO = Remotes.GitHub("JuliaAI", "MLJModelRegistry.jl")
+const  REPO = Remotes.GitHub("JuliaAI", "MLJModelRegistryTools.jl")
 
 makedocs(
-    modules=[MLJModelRegistry, GenericRegistry],
+    modules=[MLJModelRegistryTools, GenericRegistry],
     format=Documenter.HTML(
         prettyurls = true,
         collapselevel = 1,
@@ -16,13 +16,13 @@ makedocs(
         "Registry management tools" => "registry_management_tools.md",
         "Internals" => "internals.md",
     ],
-    sitename="MLJModelRegistry.jl",
+    sitename="MLJModelRegistryTools.jl",
     warnonly = [:cross_references, :missing_docs],
-    repo = Remotes.GitHub("JuliaAI", "MLJModelRegistry.jl"),
+    repo = Remotes.GitHub("JuliaAI", "MLJModelRegistryTools.jl"),
 )
 
 deploydocs(
     devbranch="dev",
     push_preview=false,
-    repo="github.com/JuliaAI/MLJModelRegistry.jl.git",
+    repo="github.com/JuliaAI/MLJModelRegistryTools.jl.git",
 )

docs/src/index.md

@@ -1,32 +1,18 @@
-# MLJModelRegistry.jl
+# MLJModelRegistryTools.jl
 
-Home of the MLJ Model Registry and tools to maintain it
+Tools to maintain the [MLJ](https://juliaml.ai) Model Registry.
 
 # What's this repository for?
 
 [MLJ](https://juliaml.ai) (Machine Learning in Julia) is a suite of Julia software
-packages providing a machine learning toolbox. The MLJModelRegistry.jl repository has two
-functions:
-
-- It hosts the *MLJ Model Registry*, a list of packages providing MLJ interfaces to
-  machine learning algorithms, together with metadata about those models, such as the type
-  of data models can operate on, and their document strings.
-  
-- It provides software tools for MLJ maintainers to manage the Model Registry, for example
-  to add the models provided by a new machine learning package providing an MLJ model
-  interface for those models.
-  
-The model registry itself consists of files in [this
-folder](https://github.com/JuliaAI/MLJModelRegisry.jl/master/registry/), ordinarily
-accessed in one of two ways:
-
-- By MLJ users, through the package
-  [MLJModels.jl](https://github.com/JuliaAI/MLJModels.jl) which downloads the registry
-  files as a Julia `Artifact`.
-
-- By developers wishing to update the registry, but using software tools provided by the
-  MLJModelRegistry.jl package, as described in this documentation.
+packages providing a machine learning toolbox. The *MLJ Model Registry*, a list of
+packages providing MLJ interfaces to machine learning algorithms, together with metadata
+about those models, such as the type of data models can operate on, and their document
+strings. This package provides software tools for MLJ maintainers to manage the Model
+Registry, for example to add the models provided by a new machine learning package
+providing an MLJ model interface for those models. It is not part of the standard MLJ
+distribution.
 
-As it is intended for MLJ developers only, none of the code provided in this repository is
-part of the standard MLJ distribution.
-
+The model registry itself is currently hosted by MLJModels.jl (part of the standard MLJ
+distribution) and lives in [this
+folder](https://github.com/JuliaAI/MLJModelRegisry.jl/master/src/registry/).

docs/src/internals.md

@@ -1,15 +1,16 @@
 # Internals 
 
 This page contains documentation for non-public API, for maintainers of
-MLJModelRegistry.jl.
+MLJModelRegistryTools.jl.
 
 ```@autodocs
 Modules = [GenericRegistry]
 ```
 ```@docs
-MLJModelRegistry.metadata
-MLJModelRegistry.encode_dic
-MLJModelRegistry.modeltype_given_constructor(modeltypes)
-MLJModelRegistry.traits_given_constructor_name
+MLJModelRegistryTools.registry_path
+MLJModelRegistryTools.metadata
+MLJModelRegistryTools.encode_dic
+MLJModelRegistryTools.modeltype_given_constructor(modeltypes)
+MLJModelRegistryTools.traits_given_constructor_name
 ```
 

docs/src/registry_management_tools.md

@@ -3,17 +3,19 @@
 ## Overview
 
 ```@docs
-MLJModelRegistry
+MLJModelRegistryTools
 ```
 
 ## Methods
 
+- [`setpath`](@ref)
 - [`update`](@ref)
-- [`MLJModelRegistry.gc`](@ref)
-- [`MLJModelRegistry.get`](@ref)
+- [`MLJModelRegistryTools.gc`](@ref)
+- [`MLJModelRegistryTools.get`](@ref)
 
 ```@docs
+setpath
 update
-MLJModelRegistry.gc
-MLJModelRegistry.get
+MLJModelRegistryTools.gc
+MLJModelRegistryTools.get
 ```

src/GenericRegistry.jl

@@ -42,8 +42,8 @@ Pkg.status()
 #  [bd369af6] Tables v1.12.1
 
 Pkg.activate(temp=true)
-Pkg.add("MLJModelRegistry")
-using MLJModelRegistry.GenericRegistry
+Pkg.add("MLJModelRegistryTools")
+using MLJModelRegistryTools.GenericRegistry
 packages = GenericRegistry.dependencies(env)
 # 2-element Vector{String}:
 #  "Tables"

src/MLJModelRegistry.jl renamed to src/MLJModelRegistryTools.jl

@@ -1,45 +1,39 @@
 """
-    MLJModelRegistry
+    MLJModelRegistryTools
 
-Module providing methods for managing the MLJ Model Registry. To modify the registry:
-
-!!! important
-
-    In any pull request to update the Model Registry you should note the final output of
-    `Pkg.status(outdated=true)` when you have MLJModels/registry activated.
+Module providing tools for managing the MLJ Model Registry. To modify the registry:
 
 - 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.
 
-- Use Julia's package manager to add or remove items from the list of registered packages
-  in the environment "MLJModels/registry/". If adding a new item, see the protocol below.
+- If needed, use Julia's package manager to add or remove items from the list of
+  registered packages in the environment "/src/registry/", inside your MLJModels.jl
+  clone. Follow the protocol below.
 
-- After adding MLJModelRegistry to some other Julia pkg environment you have activated
-(e.g., a fresh temporary one) run `using MLJModelRegistry` to make the management tools
-available.
+- In a new Julia session with MLJModelRegistryTools.jl installed, run `using
+  MLJModelRegistryTools` to make the management tools available.
 
-- Point MLJModelRegistry to the location of the registry itself within your MLJModels.jl
-  clone, using `setpath(path_to_registry)`, as in `setpath("MyPkgs/MLJModels/registry")`.
+- 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")`.
 
 - To add or update the metadata associated with a package, run [`update(pkg)`](@ref).
 
 - Assuming this is successful, update the metadata for *all* packages in the registry
   by running [`update()`](@ref).
 
 - When satisfied, commit your changes to the clone and make a pull request to the
-  MLJModelRegistry.jl repository that you cloned.
+  MLJModels.jl repository that you cloned.
 
-!!! note
+!!! important
 
-    Removing a package from the registry environment does not remove its metadata (i.e.,
-    from "/registry/Metatdata.toml"). However if you call `update()` to update all package
-    metadata (or call [`MLJModelRegistry.ac()`](@ref)) the metadata for all orphaned
-    packages is removed.
+    In any MLJModels.jl pull request to update the Model Registry you should note the
+    final output of `Pkg.status(outdated=true)` when you have /src/registry activated.
 
 # Protocol for adding new packages to the registry environment
 
-1. In your local clone of MLJModelRegistry.jl, `activate` the environment at  "/registry/".
+1. In your local clone of MLJModels.jl, `activate` the environment at  "/src/registry/".
 
 2. `update` the environment
 
@@ -49,12 +43,19 @@ available.
 
 4. Repeat steps 2 and 3 above, and investigate any dependency downgrades for which your addition may be the cause.
 
-If adding the new package results in downgrades to existing dependencies because your
+If adding the new package results in downgrades to existing dependencies, because your
 package is not up to date with it's compatibility bounds, then your pull request to
 register the new models may be rejected.
 
+!!! note
+
+    Removing a package from the registry environment does not remove its metadata. However
+    if you call `update()` to update all package metadata (or call
+    [`MLJModelRegistryTools.gc()`](@ref)) the metadata for all orphaned packages is
+    removed.
+
 """
-module MLJModelRegistry
+module MLJModelRegistryTools
 
 import MLJModelInterface
 using OrderedCollections

src/methods.jl

@@ -25,22 +25,22 @@ function clean!(dic, pkg)
     return dic
 end
 
-# develop MLJModelRegistry into the specifified `registry` project:
+# develop MLJModelRegistryTools into the specifified `registry` project:
 function setup(registry)
     ex = quote
         # REMOVE THIS NEXT LINE AFTER TAGGING NEW MLJMODELINTERFACE
         Pkg.develop(path="/Users/anthony/MLJ/MLJModelInterface/")
-        Pkg.develop(path=$ROOT) # MLJModelRegistry
+        Pkg.develop(path=$ROOT) # MLJModelRegistryTools
     end
     future = GenericRegistry.run([], ex; environment=registry)
     fetch(future)
     GenericRegistry.close(future)
 end
 
-# remove MLJModelRegistry from the specifified `registry` project:
+# remove MLJModelRegistryTools from the specifified `registry` project:
 function cleanup(registry)
     ex = quote
-        Pkg.rm("MLJModelRegistry")
+        Pkg.rm("MLJModelRegistryTools")
     end
     future = GenericRegistry.run([], ex; environment=registry)
     fetch(future)
@@ -53,10 +53,10 @@ end
 *Private method.*
 
 Extract the metadata for a package. Returns a `Future` object that must be `fetch`ed to
-get the metadata. See, [`MLJModelRegistry.update`](@ref), which calls this method, for
+get the metadata. See, [`MLJModelRegistryTools.update`](@ref), which calls this method, for
 more details.
 
-Assumes that MLJModelRegistry has been `develop`ed into `registry` if this is non-empty.
+Assumes that MLJModelRegistryTools has been `develop`ed into `registry` if this is non-empty.
 
 """
 function metadata(pkg; registry="", check_traits=true)
@@ -68,12 +68,12 @@ function metadata(pkg; registry="", check_traits=true)
         setup = quote
             # REMOVE THIS NEXT LINE AFTER TAGGING NEW MLJMODELINTERFACE
             Pkg.develop(path="/Users/anthony/MLJ/MLJModelInterface/")
-            Pkg.develop(path=$ROOT) # MLJModelRegistry
+            Pkg.develop(path=$ROOT) # MLJModelRegistryTools
         end
     end
     program = quote
-        import MLJModelRegistry
-        MLJModelRegistry.traits_given_constructor_name(
+        import MLJModelRegistryTools
+        MLJModelRegistryTools.traits_given_constructor_name(
             $pkg,
             check_traits=$check_traits,
         )
@@ -85,7 +85,7 @@ end
 # # PUBLIC METHODS
 
 """
-    MLJModelRegistry.gc()
+    MLJModelRegistryTools.gc()
 
 Remove the metadata associated with any packages that are no longer in the the model
 registry.
@@ -105,7 +105,7 @@ strings, and record this in the MLJ model registry (write it to
 
 Assumes `pkg` is already a dependency in the Julia environment defined at `/registry/` and
 uses the version of `pkg` consistent with the current environment manifest, after
-MLJModelRegistry.jl has been `develop`ed into that environment (it is removed again after
+MLJModelRegistryTools.jl has been `develop`ed into that environment (it is removed again after
 the update). See documentation for details on the registration process.
 
 ```julia-repl
@@ -127,7 +127,7 @@ The metadata dictionary, keyed on models (more precisely, constructors, thereof)
   force latest versions if these are being blocked by other packages.
 
 - `debug=false`: Calling `update` opens a temporary Julia process to extract the trait
-  metadata (see [`MLJModelRegistry.GenericRegistry.run`](@ref)). By default, this process
+  metadata (see [`MLJModelRegistryTools.GenericRegistry.run`](@ref)). By default, this process
   is shut down before rethrowing any exceptions that occurs there. Setting `debug=true`
   will leave the process open, and also block the default suppression of the remote worker
   standard output.
@@ -143,7 +143,7 @@ update(pkg, ::Quiet, registry, check_traits) =
     @suppress _update(pkg, false, registry, check_traits)
 function _update(pkg, debug, registry, check_traits)
     isempty(registry) || setup(registry)
-    future = MLJModelRegistry.metadata(pkg; registry, check_traits)
+    future = MLJModelRegistryTools.metadata(pkg; registry, check_traits)
     metadata = try
         fetch(future)
     catch excptn
@@ -205,7 +205,7 @@ function update(
         batch = pkgs[pos:pos + n - 1]
         @suppress begin
             futures =
-                [MLJModelRegistry.metadata(pkg; registry, check_traits) for pkg in batch]
+                [MLJModelRegistryTools.metadata(pkg; registry, check_traits) for pkg in batch]
             try
                 for (i, f) in enumerate(futures)
                     GenericRegistry.put(batch[i], fetch(f), registry_path())
@@ -226,11 +226,11 @@ function update(
 end
 
 """
-    MLJModelRegistry.get(pkg)
+    MLJModelRegistryTools.get(pkg)
 
 Inspect the model trait metadata recorded in the Model Registry for those models in
 `pkg`. Returns a dictionary keyed on model constructor name. Data is in serialized form;
-see [`MLJModelRegistry.encode_dic`](@ref).
+see [`MLJModelRegistryTools.encode_dic`](@ref).
 
 """
 get(pkg) = GenericRegistry.get(pkg, registry_path())