Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Model Registry doc to website #3698

Merged
merged 34 commits into from May 21, 2024

Conversation

tarilabs
Copy link
Member

Opening this PR for early feedback.

As feedback received by Release Team during KF community meetings and Model Registry meetings,
As identified in the Model Registry KF 1.9 tracker issue on request by Release Team,

➡️ Documentation is needed for Model Registry alpha on the KF website, as part of the KF 1.9 deliverables by Model Registry wg.

This PR focus on the following received requests:

  • 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 (notebooks) and add-ons (inference).

This documentations is loosely based on the content presented with this demo.

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>
Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @tarilabs. I left a few suggestions.

content/en/docs/components/model-registry/overview.md Outdated Show resolved Hide resolved
content/en/docs/components/model-registry/overview.md Outdated Show resolved Hide resolved
tarilabs and others added 4 commits April 3, 2024 11:32
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@StefanoFioravanzo
Copy link
Member

@tarilabs thanks a lot for getting this started! I went through though the current version, I think it's a good first version.

First of all a comment on timeline: we do not have to rush this in time for feature freeze. We have a couple more weeks to finetune and improve the docs. So let's keep this PR running until we have a good version.

Then, I'll refrain from commenting specific sections and instead provide some higher level feedback:

  • Overview: We can write more about how a model registry fits within the e2e ecosystem. Good reference point is the AIIA Canonical Stack of Machine learning or Google’s MLOps maturity levels that shows how a model registry is necessary to achieve level 2 maturity. These may be things we want to discuss in an introduction here OR in a blog post. Up to you. But I do believe it’s important to provide some context on why this is needed and how the ecosystem benefits

    We should also document a list of use cases and jobs that the model registry solves within the Kubeflow ecosystem. Why do I, as a Kubeflow user, care about the model registry? How does the model registry help me solve my day to day tasks faster, better, more efficiently? What problems does the model registry solve that I wouldn’t otherwise be able to solve?

  • Getting Started: I would split up the getting started into two guides:

    1. Installation / pre-requisites → this is particularly important while this is in alpha and not included into Kubeflow core
    2. Actual "getting started" guide with a practical step-by-step tutorial (assuming one has already installed it)

    This is important because installation is a one off thing (done by the Kubeflow admin) whereas the getting started guide targets ML practitioners who just use the platform

  • I'd also love to see an architecture diagram under a "reference" section.

  • Additionally, we can plan for a separate page to discuss specific integrations and integration plans with other Kubeflow components and third-party software (can go under "reference")

I know it's a lot. Great documentation takes a lot of time and effort. Let's try and do these things incrementally.

I hope that @diegolovison and @hbelmiro can also help out a little bit here.
Looking forward to hearing your thoughts!

@tarilabs
Copy link
Member Author

tarilabs commented Apr 10, 2024

First of all a comment on timeline: we do not have to rush this in time for feature freeze. We have a couple more weeks to finetune and improve the docs. So let's keep this PR running until we have a good version.

ack, and agreed

  • We should also document a list of use cases and jobs that the model registry solves within the Kubeflow ecosystem

yes, this was discussed in the KF community-calls, in the KF MR bi-weekly Josh already suggested the same, we're iterating on a google doc already which will be "poured" in content into this PR as soon as the copy is ready

  • Getting Started: I would split up the getting started into two guides

noted, will do
👉 done with 2f567ae

  • I'd also love to see an architecture diagram under a "reference" section.

noted, will do
👉 done with 3bbf750

Thanks for the feedback @StefanoFioravanzo ! 📥 ✍️

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
@google-oss-prow google-oss-prow bot removed the lgtm label Apr 15, 2024
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
under a "Reference" section

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
...into an Installation page
and the "actual" getting-started example guide

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


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

Co-authored-by: Helber Belmiro <helber.belmiro@gmail.com>
tarilabs and others added 2 commits April 15, 2024 15:53
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Andrea Lamparelli <a.lamparelli95@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Andrea Lamparelli <a.lamparelli95@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
as requested in meeting

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
@StefanoFioravanzo
Copy link
Member

@tarilabs @andreyvelich I see there are a few last comments to be addressed here. Can we quickly close the loop and get this merged?

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

Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
@google-oss-prow google-oss-prow bot removed the lgtm label May 20, 2024
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
@tarilabs
Copy link
Member Author

@tarilabs @andreyvelich I see there are a few last comments to be addressed here. Can we quickly close the loop and get this merged?

yep thanks again for the feedback @andreyvelich , I addressed most of them, about the remaining kindly let me know if, as discussed previously in this thread, do you require them as part of this PR or could be follow-ed up in subsequent PRs (so as also to "parallelize" changes). Thank you!

@andreyvelich
Copy link
Member

@tarilabs @andreyvelich I see there are a few last comments to be addressed here. Can we quickly close the loop and get this merged?

yep thanks again for the feedback @andreyvelich , I addressed most of them, about the remaining kindly let me know if, as discussed previously in this thread, do you require them as part of this PR or could be follow-ed up in subsequent PRs (so as also to "parallelize" changes). Thank you!

Sure, we can incorporate them in a following PR. Do you want to address this change in the next PR: #3698 (comment) ?

tarilabs and others added 2 commits May 21, 2024 11:40
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Josh Bottum <joshbottum@gmail.com>
tarilabs and others added 3 commits May 21, 2024 12:00
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: Josh Bottum <joshbottum@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>

Co-authored-by: Josh Bottum <joshbottum@gmail.com>
@tarilabs
Copy link
Member Author

Sure, we can incorporate them in a following PR. Do you want to address this change in the next PR: #3698 (comment) ?

unless anyone has any "blocker" or "veto" comments, since this PR has been open for a long time (March) and incorporated as many comments as possible in the time being (see thread), I'd be happy to have it merged, and parallelize any further comments/amendments in separate PRs (multiple).

Kindly let me know your guidance here, and once again thanks for all who contributed reviews!!

@andreyvelich
Copy link
Member

Absolutely, thanks again for your hard work @tarilabs!
/lgtm
/assign @jbottum for the approval

Copy link

@andreyvelich: GitHub didn't allow me to assign the following users: for, the, approval.

Note that only kubeflow members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

Absolutely, thanks again for your hard work @tarilabs!
/lgtm
/assign @jbottum for the approval

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@jbottum
Copy link
Contributor

jbottum commented May 21, 2024

/lgtm

@jbottum
Copy link
Contributor

jbottum commented May 21, 2024

/approve

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jbottum

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit 3a6fe0c into kubeflow:master May 21, 2024
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants