Skip to content

Commit 598f249

Browse files
committed
simplify readme
tweak
1 parent 14c1a7b commit 598f249

File tree

2 files changed

+5
-19
lines changed

2 files changed

+5
-19
lines changed

README.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,13 @@
11
# MLJModelRegistry.jl
22

3-
Home of the MLJ Model Registry
3+
Home of the MLJ Model Registry and tools to maintain it
44

55
[![Build Status](https://github.com/JuliaAI/MLJModelRegistry.jl/workflows/CI/badge.svg)](https://github.com/JuliaAI/MLJModelRegistry.jl/actions)
66
[![codecov](https://codecov.io/gh/JuliaAI/MLJModelRegistry.jl/graph/badge.svg?token=9IWT9KYINZ)](https://codecov.io/gh/JuliaAI/MLJModelRegistry.jl?branch=dev)
77
[![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaai.github.io/MLJModelRegistry.jl/dev/)
88
[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaai.github.io/MLJModelRegistry.jl/stable/)
99

10-
## What is this repository for?
11-
12-
[MLJ](https://juliaml.ai) (Machine Learning in Julia) is a suite of Julia software
13-
packages providing a machine learning toolbox. The MLJModelRegistry.jl has two functions:
14-
15-
- It hosts the *MLJ Model Registry*, a list of packages providing MLJ interfaces to
16-
machine learning algorithms, together with metadata about those models, such as the type
17-
of data models can operate on.
18-
19-
- It provides software tools for MLJ maintainers to manage the Model Registry, for example
20-
to add the models provided by a new machine learning package providing an MLJ model
21-
interface for those models.
22-
23-
This repository does not provide any MLJ user code but does contain metadata downloaded as
24-
a Julia `Artifact` by MLJ software. See the
25-
[documentation](https://juliaai.github.io/MLJModelRegistry.jl/stable/) for details.
10+
What is this repository for? See
11+
[here](https://juliaai.github.io/MLJModelRegistry.jl/stable/#What's-this-repository-for?).
2612

2713

docs/src/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# MLJModelInterface.jl
1+
# MLJModelRegistry.jl
22

3-
Home of the MLJ Model Registry
3+
Home of the MLJ Model Registry and tools to maintain it
44

55
# What's this repository for?
66

0 commit comments

Comments
 (0)