kubeflow / website

Kubeflow's public website
Creative Commons Attribution 4.0 International
145 stars 752 forks source link

Add Kubeflow Components Overview Diagram #3650

Closed andreyvelich closed 6 months ago

andreyvelich commented 6 months ago

This diagram shows high-level diagram for Kubeflow components, so users can see which part of MLOps lifecycle Kubeflow covers today. We can edit this diagram in the future by simply import it to: https://www.drawio.com/

We showed this diagram in the latest Kubeflow Summit: https://youtu.be/HBBJYa4JTNY?list=PL2gwy7BdKoGdrkYIWGeAdKi9ntfxq8FYt

Related: https://github.com/kubeflow/website/issues/3536

/hold for review

andreyvelich commented 6 months ago

cc for the review on the Kubeflow high-level architecture. @kubeflow/wg-training-leads @kubeflow/wg-pipeline-leads @kubeflow/wg-notebooks-leads @jbottum @thesuperzapper @akgraner @vikas-saxena02

thesuperzapper commented 6 months ago

@andreyvelich I thought your diagram going to be used on the "introduction" page rather than the "architecture"?

And that we would use a diagram like this one on the "architecture" page:

Screenshot 2023-12-15 at 10 22 57

andreyvelich commented 6 months ago

I thought your diagram going to be used on the "introduction" page rather than the "architecture"?

Yes, let me move it to introduction for now. I hope, we have time to discuss it during tomorrow's community call to hear the feedback from others.

vikas-saxena02 commented 6 months ago

@andreyvelich , the diagram looks great to me!! I just have one suggestion though, for the ML Libraries section on top. Is it possible to provide names for the ones which do not have it mentioned in the icon. For non-technical users (managers, BAs etc) it will be confusing as they do not know which library is that.

andreyvelich commented 6 months ago

@andreyvelich , the diagram looks great to me!! I just have one suggestion though, for the ML Libraries section on top. Is it possible to provide names for the ones which do not have it mentioned in the icon. For non-technical users (managers, BAs etc) it will be confusing as they do not know which library is that.

That's good point @vikas-saxena02. I will make this change to the diagram.

andreyvelich commented 6 months ago

@thesuperzapper @terrytangyuan @johnugeorge @tenzen-y @hbelmiro @vikas-saxena02 @jbottum Any other suggestions before we can merge this initial diagram ?

hbelmiro commented 6 months ago

/lgtm

google-oss-prow[bot] commented 6 months ago

@hbelmiro: changing LGTM is restricted to collaborators

In response to [this](https://github.com/kubeflow/website/pull/3650#issuecomment-1881064269): >/lgtm Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
jbottum commented 6 months ago

/lgtm

thesuperzapper commented 6 months ago

@andreyvelich I like where you are going but I think it can still be made more clear.

I have taken a stab at it based on your design, I went back and forward on keeping the "Web UI" box, but settled on replacing "ML Metadata" with "Central Dashboard" because that's similar to what we do on the kubeflow.org homepage.

The following file is in SVG draw.io format if you want to modify it further:

kubeflow-intro-diagram drawio

PS: we should use SVG rather than PNG for the website (don't forget to click "embed images" when exporting from draw.io)

Here is a compressed version of the PNG format, incase GitHub comments break the image draw.io compatibility: kubeflow-intro-diagram.drawio.png.zip

andreyvelich commented 6 months ago

Sure @thesuperzapper, that sound good, I made the appropriate changes. I keep components in the appropriate order (e.g. on the left side: ML Training, ML Tuning, ML Serving. On the right side development tools: Notebooks, Pipelines, Central Dashboard ) /hold cancel

thesuperzapper commented 6 months ago

@andreyvelich based on your comment I think we can add the "Model Training" / etc labels underneath each component to help new users understand what each box means.

I also think that it makes sense to put the development tools on the left side (the same order we use on the homepage).

For example: kubeflow-intro-diagram-2 drawio

And the compressed file version: kubeflow-intro-diagram-2.drawio.svg.zip

thesuperzapper commented 6 months ago

@andreyvelich Based on a few comments I have made the labels a lot less prominent

kubeflow-intro-diagram-3 drawio

kubeflow-intro-diagram-3.drawio.svg.zip

andreyvelich commented 6 months ago

I made the final changes based on the discussion. Please provide your final comments and we can merge it. /assign @thesuperzapper @terrytangyuan @johnugeorge @tenzen-y @hbelmiro @vikas-saxena02 @jbottum @james-jwu @zijianjoy

zijianjoy commented 6 months ago

/lgtm /approve

Thank you @andreyvelich and everyone for your help on this PR!

google-oss-prow[bot] commented 6 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andreyvelich, hbelmiro, terrytangyuan, zijianjoy

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: - ~~[content/en/docs/started/OWNERS](https://github.com/kubeflow/website/blob/master/content/en/docs/started/OWNERS)~~ [zijianjoy] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
tenzen-y commented 6 months ago

@andreyvelich Thank you for this improvement! This looks great :)