-
Notifications
You must be signed in to change notification settings - Fork 791
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
Training: Add documentation for the MultiKueue and spec.managedBy API #3956
Open
Garvit-77
wants to merge
7
commits into
kubeflow:master
Choose a base branch
from
Garvit-77:Manageby
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
4b02eec
resolves kubeflow/training/#2279
Garvit-77 fe517b1
Update content/en/docs/components/training/user-guides/managedby.md
Garvit-77 af5ac9e
Update content/en/docs/components/training/user-guides/managedby.md
Garvit-77 2c2cd7d
Update content/en/docs/components/training/user-guides/managedby.md
Garvit-77 cbac0ed
Update content/en/docs/components/training/user-guides/managedby.md
Garvit-77 713beb7
Update content/en/docs/components/training/user-guides/managedby.md
Garvit-77 0df155e
Update content/en/docs/components/training/user-guides/managedby.md
Garvit-77 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
65 changes: 65 additions & 0 deletions
65
content/en/docs/components/training/user-guides/managedby.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
+++ | ||
title = "spec.managedBy" | ||
Desciption = "Using managedBy field for MultiKueue" | ||
weight = 60 | ||
+++ | ||
|
||
## Overview | ||
|
||
The `spec.managedBy` field is a new feature introduced in the Kubeflow Training Operator to support a more robust multi-cluster job dispatching by [MultiKueue](https://kueue.sigs.k8s.io/docs/concepts/multikueue/). | ||
|
||
## Prerequisites | ||
|
||
1. Ensure that you have the latest version of the Kubeflow Training Operator installed. | ||
2. Make sure Kueue is compiled against the new operator to leverage the `spec.managedBy` field. | ||
|
||
## Usage | ||
|
||
To use the `spec.managedBy` field in your training jobs, include it in the job specification as shown below: | ||
|
||
```yaml | ||
apiVersion: "kubeflow.org/v1" | ||
kind: "TFJob" | ||
metadata: | ||
name: "example-tfjob" | ||
spec: | ||
managedBy: "kueue.x-k8s.io/multikueue" | ||
tfReplicaSpecs: | ||
... | ||
``` | ||
|
||
Example | ||
|
||
Here is a complete example of a TensorFlow job using the spec.managedBy field: | ||
|
||
```YAML | ||
apiVersion: "kubeflow.org/v1" | ||
kind: "TFJob" | ||
metadata: | ||
name: "example-tfjob" | ||
spec: | ||
managedBy: "kueue" | ||
Garvit-77 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
tfReplicaSpecs: | ||
Chief: | ||
replicas: 1 | ||
template: | ||
spec: | ||
containers: | ||
- name: tensorflow | ||
image: tensorflow/tensorflow:latest | ||
args: ["python", "model.py"] | ||
Worker: | ||
replicas: 2 | ||
template: | ||
spec: | ||
containers: | ||
- name: tensorflow | ||
image: tensorflow/tensorflow:latest | ||
args: ["python", "model.py"] | ||
``` | ||
|
||
## What's next? | ||
|
||
For more details on setting up and using MultiKueue with the Kubeflow Training Operator, refer to the following documentation pages: | ||
|
||
- [Kueue/Kubeflow](https://kueue.sigs.k8s.io/docs/tasks/run/multikueue/kubeflow/) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, underneath Kueue will add a webhook which will default the field, so the example will not need to include it. I think we can just rely on the example eventually added to the MultiKueue documentation once kubernetes-sigs/kueue#2552 is done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
WDYT @tenzen-y @andreyvelich ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think we can reference to the example in Kueue docs, so we can be consistent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, I suggest to drop it in this PR so that we only have one place about the details. Note that the Kueue documentation is not added yet. Once done we will x-ref the pages.