Commit Graph

8 Commits

Author SHA1 Message Date
Paul Boyd b4f1910259
model-registry: update the installation guide (#4042)
I found installing model registry from the instructions on the website
to be rather hard to do. The instructions don't actually have all the
steps needed, so it sent me to the README in the manifests repo. Which,
confusingly, sent me right back to the website. Neither document is
entirely complete so I had to coble together bits from both places.

I'm assuming these instructions are primarily useful to existing
Kubeflow users who want to try out model registry so I've rewritten the
"Installing on Kubeflow Platform" section with the idea to get those
users up and running quickly. I'm further assuming that these users will
want the UI (I mean, it's a good UI, who wouldn't?) so we can cut the
"if you want the UI verbage" and simplify some of the commands.

Signed-off-by: Paul Boyd <pboyd@redhat.com>
2025-03-20 16:50:03 +00:00
Lucas Fernandez 7cb931dc86
Add model registry UI installation instructions (#4013)
Signed-off-by: Lucas Fernandez <lucasfernandezaragon@gmail.com>
2025-03-03 13:55:45 +00:00
Mathew Wicks 6aefa59614
Add Swagger UI for Model Registry (#3980)
Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
2025-02-14 22:29:37 +00:00
Alessio Pragliola 42e0e45210
doc(model-registry): Added Model Registry CSI documentation to installation and getting started sections (#3922)
* feat(mr): added csi mr docs

Signed-off-by: Alessio Pragliola <seth.pro@gmail.com>

* chore(mr): bump model-registry/csi to 0.2.10

Signed-off-by: Alessio Pragliola <seth.pro@gmail.com>

* chore(mr): apply suggestions from code review

Co-authored-by: Matteo Mortari <matteo.mortari@gmail.com>
Signed-off-by: Alessio Pragliola <83355398+Al-Pragliola@users.noreply.github.com>

---------

Signed-off-by: Alessio Pragliola <seth.pro@gmail.com>
Signed-off-by: Alessio Pragliola <83355398+Al-Pragliola@users.noreply.github.com>
Co-authored-by: Matteo Mortari <matteo.mortari@gmail.com>
2024-11-11 09:27:16 +00:00
Isabella Basso 1b152f5244
MR: update getting started (#3801)
* MR: update getting started

Signed-off-by: Isabella do Amaral <idoamara@redhat.com>

* bump version in installation.md

Signed-off-by: tarilabs <matteo.mortari@gmail.com>

---------

Signed-off-by: Isabella do Amaral <idoamara@redhat.com>
Signed-off-by: tarilabs <matteo.mortari@gmail.com>
Co-authored-by: tarilabs <matteo.mortari@gmail.com>
2024-07-16 06:59:55 +00:00
Matteo Mortari ecc1572810
misc updates to KF Model Registry tutorial (#3788)
* add suggestions how to dry-run from notebook

based on return-from-experience from
https://github.com/kubeflow/model-registry/issues/90#issuecomment-2143788711

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* refresh by pin to latest v0.2.2-alpha

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* pin MR python client version too

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* update with required arg is_secure=False

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* align model-version used in the tutorial

https://github.com/kubeflow/model-registry/issues/109#issue-2309990930

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

---------

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
2024-07-02 12:14:44 +00:00
Matteo Mortari 5fce3819a9
model registry: pin tag and standalone instructions (#3740)
* model registry: pin tag and standalone instructions

implements suggestions from KF community meeting 2024-05-22

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* add owners file

using same members from all owners file in KF/model-registry repo at this time

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

---------

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
2024-06-13 13:39:08 +00:00
Matteo Mortari 3a6fe0c7e8
add Model Registry doc to website (#3698)
* add Model Registry doc to website

The documentation is to highlight how to onboard users.
A component is added to KF website sidebar.
Use Alpha version marker.
The doc highlight how to install, use Python client, examples of integrations with other components and add-ons.

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>

* Update content/en/docs/components/model-registry/getting-started.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>

* fix to updated link

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* update diagram to show inner/outer MLOps loops

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review req for architecture page

under a "Reference" section

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review req for splitting getting-started

...into an Installation page
and the "actual" getting-started example guide

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* Update content/en/docs/components/model-registry/reference/architecture.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>

* Update content/en/docs/components/model-registry/installation.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Andrea Lamparelli <a.lamparelli95@gmail.com>

* fix wrong command in installation

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Andrea Lamparelli <a.lamparelli95@gmail.com>

* update for better reproducible kserve add-on example

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* add short sentence for each phase in the ML lifecycle

as requested in meeting

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* add "model registry use case" section

as required from previous meeting

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>

* implement review feedback on diagram

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: StefanoFioravanzo <stefano.fioravanzo@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: StefanoFioravanzo <stefano.fioravanzo@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: StefanoFioravanzo <stefano.fioravanzo@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: StefanoFioravanzo <stefano.fioravanzo@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: StefanoFioravanzo <stefano.fioravanzo@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* Update content/en/docs/components/model-registry/overview.md

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* fix broken link on review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Josh Bottum <joshbottum@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Josh Bottum <joshbottum@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Josh Bottum <joshbottum@gmail.com>

* implement review feedback

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Josh Bottum <joshbottum@gmail.com>

---------

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>
Co-authored-by: Andrea Lamparelli <a.lamparelli95@gmail.com>
Co-authored-by: StefanoFioravanzo <stefano.fioravanzo@gmail.com>
Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
Co-authored-by: Josh Bottum <joshbottum@gmail.com>
2024-05-21 22:33:24 +00:00