@@ -7,25 +7,27 @@ Module providing methods for managing the MLJ Model Registry. To modify the regi
7
7
repository](https://github.com/JuliaAI/MLJModelRegistry.jl)
8
8
9
9
- Use Julia's package manager to add or remove items from the list of registered packages
10
- in the environment "/registry/". If adding a new item, see the protocol below.
10
+ in the environment "/registry/", located in the root directory of your clone. If adding
11
+ a new item, see the protocol below.
11
12
12
13
- In a fresh temporary environment, run `Pkg.develop("path_to_clone")` and `using
13
14
MLJModelRegistry`.
14
15
15
- - To add or update the metadata associated with a package (compulsory for new packages)
16
- run [`update(pkg)`](@ref)
16
+ - To add or update the metadata associated with a package, run [`update(pkg)`](@ref).
17
17
18
- - To update the metadata for *all* packages in the registry, run [`update()`](@ref).
18
+ - Alternatively, to update the metadata for *all* packages in the registry (optional but
19
+ recommended), run [`update()`](@ref).
19
20
20
21
- When satisfied, commit your changes to the clone and make a pull request to the master
21
22
MLJModelRegistry.jl repository.
22
23
23
24
!!! important
24
25
25
26
Removing a package from the "/registry/" enviroment does not remove its metadata from
26
- the Model Registry (from "/registry/Metatdata.toml"). Unless you later call `update()`
27
- to update all package metadata (slow), you must call [`MLJModelRegistry.gc()`](@ref) to
28
- specifically remove metadata for all orphaned packages (fast).
27
+ the Model Registry (i.e., from "/registry/Metatdata.toml"). Unless you later call
28
+ `update()` to update all package metadata (slow), you must call
29
+ [`MLJModelRegistry.gc()`](@ref) to specifically remove metadata for all orphaned
30
+ packages (fast).
29
31
30
32
# Protocol for adding new packages to the registry environment
31
33
0 commit comments