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 UI installation instructions #4013

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

lucferbux
Copy link

Checklist:

  • You have signed off your commits
  • Ensure you follow best practices from our guide. Contributing.
  • [] You have included screenshots when changing the website style or adding a new page.

Description of your changes:
Added a Model Registry UI section in under Model Registry.

Issue

Closes: #

Labels


Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign rareddy for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@@ -26,6 +26,24 @@ Kubeflow Model Registry is available as an opt-in alpha component in Kubeflow Pl

If you have deployed the Kubeflow manifests, you may follow [these instructions](https://github.com/kubeflow/manifests/tree/master/apps/model-registry/upstream#readme) to deploy Model Registry; please raise any feedback on [`kubeflow/model-registry`](https://github.com/kubeflow/model-registry/issues).
Copy link
Contributor

Choose a reason for hiding this comment

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

It's possible a user might do this before ever seeing the notes below. Maybe we need a note here that says see the section below if you are planning to use the Kubeflow UI? Not sure what scenario you would want to have MR in the kubeflow namespace if you plan to use the Kubeflow Platform / Dashboard

Copy link
Author

Choose a reason for hiding this comment

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

You are right, I'll get a warning to follow next step if they plan to install MR UI

Copy link
Member

@ederign ederign left a comment

Choose a reason for hiding this comment

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

IMO, we just need to incorporate @Griffin-Sullivan suggestion. The getting started section could be in a FUP PR.

@@ -7,7 +7,7 @@ weight = 20
This guide shows how to get started with Model Registry and run a few examples using the
command line or Python clients.

At this time, the Model Registry does not include a web-based User Interface (UI), therefore this documentation focuses on backend services and APIs.
<!-- TODO: Check with MR team to see if we include screenshots for a UI "get started" -->
Copy link
Member

Choose a reason for hiding this comment

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

@lucferbux, we can do this in a FUP PR, but as the UI is an important piece of Model Registry, I would suggest figuring out how to mention the UI in this section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants