-
Notifications
You must be signed in to change notification settings - Fork 104
Docs : Add HyperJob concept documentation for multi-cluster job splitting #477
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
base: master
Are you sure you want to change the base?
Docs : Add HyperJob concept documentation for multi-cluster job splitting #477
Conversation
Introduce HyperJob documentation in both English and Chinese Concepts sections, covering multi-cluster job splitting, key features, use cases, and distinctions from standard Volcano Jobs Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello @codeEvolveZenith345, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the Volcano project's documentation by introducing the HyperJob concept. HyperJob provides a crucial high-level abstraction for managing large-scale AI/ML workloads across multiple Kubernetes clusters, simplifying complex distributed job orchestration. It aims to improve resource utilization and provide a unified control plane for jobs that span heterogeneous and geographically dispersed environments, thereby making multi-cluster AI job scheduling more accessible and efficient. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
/cc @JesseStutler |
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.
Code Review
This pull request successfully introduces comprehensive documentation for the HyperJob concept in both English and Chinese. The new hyperjob.md files clearly explain the purpose, key features, use cases, and architecture of HyperJob, along with a helpful conceptual YAML example. Additionally, the cross-references added to the multi_cluster_scheduling.md files significantly improve the discoverability of this new concept. The documentation is well-structured and provides valuable information for users looking to understand multi-cluster job splitting with HyperJob.
Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
JesseStutler
left a comment
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.
Please also solve these comments in zh docs
…with comparison table, real-world use cases, and complete YAML examples from design doc. Removed architecture overview to keep focus on user-facing concepts Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
|
Hi @JesseStutler I have refactored both the files as per your review. please review it again! |
Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
4440ff8 to
b4b0aa2
Compare
Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
Description
Introduce HyperJob documentation in both English and Chinese Concepts sections, covering multi-cluster job splitting, key features, use cases, and distinctions from standard Volcano Jobs
/kind documentation
This PR adds comprehensive documentation for the HyperJob concept to the Volcano website in both English and Chinese. HyperJob is a high-level multi-cluster scheduling abstraction built on top of Volcano Job that enables:
Additionally, cross-reference links have been added to the existing Multi-Cluster Scheduling documentation to improve discoverability.
Fixes #475