-
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
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Garvit-77 <[email protected]>
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
Hi @Garvit-77. 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 Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
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-to-test
@andreyvelich please review the PR and let me know if any changes are expected |
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.
|
... | ||
``` | ||
|
||
Example |
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.
FYI, I think the feature will be almost completely a technical detail hidden from the users, as we are going to default the field in MultiKueue by a webhook once kubernetes-sigs/kueue#2552 is done. So, I think describing the field is ok, but eventually a "plain" TFJob is what the user yaml contains. So, I think we will be able to reference to the MultiKueue docs for example. |
Co-authored-by: Michał Woźniak <[email protected]> Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]> Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]> Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]> Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]> Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]> Signed-off-by: Garvit Khandelwal <[email protected]>
This Documentation resolves :
kubeflow/training-operator/issues/2279