Skip to content

Commit 53ab64f

Browse files
committed
doc tweaks
1 parent f7968d9 commit 53ab64f

File tree

4 files changed

+13
-11
lines changed

4 files changed

+13
-11
lines changed

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ functions:
1010

1111
- It hosts the *MLJ Model Registry*, a list of packages providing MLJ interfaces to
1212
machine learning algorithms, together with metadata about those models, such as the type
13-
of data models can operate on.
13+
of data models can operate on, and their document strings.
1414

1515
- It provides software tools for MLJ maintainers to manage the Model Registry, for example
1616
to add the models provided by a new machine learning package providing an MLJ model

docs/src/registry_management_tools.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ MLJModelRegistry
99
## Methods
1010

1111
- [`update`](@ref)
12-
- [`ModelRegistry.gc`](@ref)
13-
- [`ModelRegistry.get`](@ref)
12+
- [`MLJModelRegistry.gc`](@ref)
13+
- [`MLJModelRegistry.get`](@ref)
1414

1515
```@docs
1616
update

src/MLJModelRegistry.jl

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,27 @@ Module providing methods for managing the MLJ Model Registry. To modify the regi
77
repository](https://github.com/JuliaAI/MLJModelRegistry.jl)
88
99
- 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.
1112
1213
- In a fresh temporary environment, run `Pkg.develop("path_to_clone")` and `using
1314
MLJModelRegistry`.
1415
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).
1717
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).
1920
2021
- When satisfied, commit your changes to the clone and make a pull request to the master
2122
MLJModelRegistry.jl repository.
2223
2324
!!! important
2425
2526
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).
2931
3032
# Protocol for adding new packages to the registry environment
3133

src/methods.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ strings, and record it in the MLJ model registry (write it to
7171
`/registry/Metadata.toml`).
7272
7373
Assumes `pkg` is already a dependency in the Julia enviroment defined at `/registry/`. See
74-
[`MLJModelRegistry`](@ref) for details on the registration process.
74+
documentation for details on the registration process.
7575
7676
```julia-repl
7777
julia> update("MLJDecisionTreeInterface")

0 commit comments

Comments
 (0)