Add one-liner info about components of KubeFlow to docs #4055

nb923 · 2025-03-23T16:15:47Z

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 one liner descriptions about components in /docs/components/ as suggested by issue #4043.

Issue #4043

Closes: #4043

Labels

/area website

Signed-off-by: nb923 <[email protected]>

google-oss-prow · 2025-03-23T16:15:57Z

Hi @nb923. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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/test-infra repository.

google-oss-prow · 2025-03-23T16:16:01Z

[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 andreyvelich for approval. For more information see the Kubernetes Code Review Process.

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

Details

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

Arhell

/ok-to-test

milinddethe15

I suggest to specify feature of each components.

milinddethe15 · 2025-04-09T09:34:15Z

content/en/docs/components/model-registry/_index.md

 +++
 title = "Model Registry"
-description = "Documentation for Kubeflow Model Registry"
+description = "Central Index for Indexing and Managing ML Models"


Suggested change

description = "Central Index for Indexing and Managing ML Models"

description = "Repository for storing and versioning ML models and metadata"

sorry but model registry is NOT a repository, it's a metadata-only-store.

milinddethe15 · 2025-04-09T09:34:43Z

content/en/docs/components/notebooks/_index.md

 +++
 title = "Kubeflow Notebooks"
-description = "Documentation for Kubeflow Notebooks"
+description = "Running Development Environments Inside Kubernetes Clusters"


Suggested change

description = "Running Development Environments Inside Kubernetes Clusters"

description = "Interactive environments for data exploration and model development"

milinddethe15 · 2025-04-09T09:35:23Z

content/en/docs/components/pipelines/_index.md

 +++
 title = "Kubeflow Pipelines"
-description = "Documentation for Kubeflow Pipelines."
+description = "Building and Deploying Scalable ML Workflows in Docker Containers"


Suggested change

description = "Building and Deploying Scalable ML Workflows in Docker Containers"

description = "Platform for building and deploying ML workflows using containers"

We should not call Kubeflow Pipeline a platform, since "Kubeflow is a collection of tools", and KFP is just one tool from Kubeflow Foundation.

We also use OCI instead of docker.

milinddethe15 · 2025-04-09T09:36:36Z

content/en/docs/components/trainer/_index.md

 +++
 title = "Kubeflow Trainer"
-description = "Documentation for Kubeflow Trainer"
+description = "Kubernetes-Native LLM Fine-Tuning and Distributed ML Trainings"


Suggested change

description = "Kubernetes-Native LLM Fine-Tuning and Distributed ML Trainings"

description = "Distributed training toolkit for machine learning models"

I like that we call it Kubernetes-native tool for fine-tuning LLMs and model distributed training.

milinddethe15 · 2025-04-09T09:45:52Z

content/en/docs/components/katib/_index.md

 +++
 title = "Katib"
-description = "Documentation for Kubeflow Katib"
+description = "Kubernetes-Native Automated Machine Learning (AutoML)"


Suggested change

description = "Kubernetes-Native Automated Machine Learning (AutoML)"

description = "Hyperparameter tuning and neural architecture search tool"

I prefer if we call Katib, tool for AutoML on Kubernetes.

milinddethe15 · 2025-04-09T09:54:35Z

cc @kubeflow/kubeflow-steering-committee for review

juliusvonkohout · 2025-06-17T14:46:51Z

@andreyvelich @tarilabs @hbelmiro please review

tarilabs

reviewed as requested, with optional suggestion below

/lgtm

content/en/docs/components/model-registry/_index.md

Co-authored-by: Matteo Mortari <[email protected]> Signed-off-by: Julius von Kohout <[email protected]>

google-oss-prow · 2025-06-17T15:42:07Z

New changes are detected. LGTM label has been removed.

andreyvelich

We need WG to review this one-liner info for each Kubeflow Tool.
cc @kubeflow/wg-training-leads @kubeflow/wg-automl-leads @kubeflow/wg-data-leads @kubeflow/wg-pipeline-leads @kubeflow/wg-notebooks-leads @kubeflow/wg-manifests-leads @kubeflow/kubeflow-steering-committee

andreyvelich · 2025-06-26T12:23:44Z

content/en/docs/components/katib/_index.md

 +++
 title = "Katib"
-description = "Documentation for Kubeflow Katib"
+description = "Kubernetes-Native Automated Machine Learning (AutoML)"


I prefer if we call Katib, tool for AutoML on Kubernetes.

andreyvelich · 2025-06-26T12:24:42Z

content/en/docs/components/pipelines/_index.md

 +++
 title = "Kubeflow Pipelines"
-description = "Documentation for Kubeflow Pipelines."
+description = "Building and Deploying Scalable ML Workflows in Docker Containers"


We should not call Kubeflow Pipeline a platform, since "Kubeflow is a collection of tools", and KFP is just one tool from Kubeflow Foundation.

andreyvelich · 2025-06-26T12:25:39Z

content/en/docs/components/trainer/_index.md

 +++
 title = "Kubeflow Trainer"
-description = "Documentation for Kubeflow Trainer"
+description = "Kubernetes-Native LLM Fine-Tuning and Distributed ML Trainings"


I like that we call it Kubernetes-native tool for fine-tuning LLMs and model distributed training.

tarilabs · 2025-06-26T12:27:09Z

We need WG to review this one-liner info for each Kubeflow Tool.

thank you @andreyvelich , for MR WG we did it with #4055 (review)

github-actions · 2025-09-25T00:30:33Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions · 2025-10-16T00:31:42Z

This pull request has been automatically closed because it has not had recent activity.You can reopen the PR if you want.

Add one-liner info about components of KubeFlow to docs

c5dc010

Signed-off-by: nb923 <[email protected]>

google-oss-prow bot added area/website AREA: Website Styles/Hosting/Serving needs-ok-to-test labels Mar 23, 2025

google-oss-prow bot requested review from jacobsalway and varodrig March 23, 2025 16:16

google-oss-prow bot added the size/S label Mar 23, 2025

Arhell reviewed Mar 24, 2025

View reviewed changes

google-oss-prow bot added ok-to-test and removed needs-ok-to-test labels Mar 24, 2025

milinddethe15 reviewed Apr 9, 2025

View reviewed changes

tarilabs reviewed Jun 17, 2025

View reviewed changes

content/en/docs/components/model-registry/_index.md Outdated Show resolved Hide resolved

google-oss-prow bot assigned tarilabs Jun 17, 2025

google-oss-prow bot added the lgtm label Jun 17, 2025

Update content/en/docs/components/model-registry/_index.md

82e2797

Co-authored-by: Matteo Mortari <[email protected]> Signed-off-by: Julius von Kohout <[email protected]>

google-oss-prow bot removed the lgtm label Jun 17, 2025

andreyvelich reviewed Jun 26, 2025

View reviewed changes

github-actions bot added the lifecycle/stale label Sep 25, 2025

github-actions bot closed this Oct 16, 2025

	description = "Central Index for Indexing and Managing ML Models"
	description = "Repository for storing and versioning ML models and metadata"

	description = "Running Development Environments Inside Kubernetes Clusters"
	description = "Interactive environments for data exploration and model development"

	description = "Building and Deploying Scalable ML Workflows in Docker Containers"
	description = "Platform for building and deploying ML workflows using containers"

	description = "Kubernetes-Native LLM Fine-Tuning and Distributed ML Trainings"
	description = "Distributed training toolkit for machine learning models"

	description = "Kubernetes-Native Automated Machine Learning (AutoML)"
	description = "Hyperparameter tuning and neural architecture search tool"

Add one-liner info about components of KubeFlow to docs #4055

Add one-liner info about components of KubeFlow to docs #4055

Uh oh!

Conversation

nb923 commented Mar 23, 2025

Issue #4043

Labels

Uh oh!

google-oss-prow bot commented Mar 23, 2025

Uh oh!

google-oss-prow bot commented Mar 23, 2025

Uh oh!

Arhell left a comment

Choose a reason for hiding this comment

Uh oh!

milinddethe15 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

milinddethe15 commented Apr 9, 2025

Uh oh!

juliusvonkohout commented Jun 17, 2025

Uh oh!

tarilabs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

google-oss-prow bot commented Jun 17, 2025

Uh oh!

andreyvelich left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tarilabs commented Jun 26, 2025

Uh oh!

github-actions bot commented Sep 25, 2025

Uh oh!

github-actions bot commented Oct 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants