Skip to content

[doc] Jobflow parameter overrides #4411

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.

Sign up for GitHub

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

Jump to bottom
Merged
volcano-sh-bot merged 1 commit into from
Jul 17, 2025
Merged

[doc] Jobflow parameter overrides #4411

volcano-sh-bot merged 1 commit into from
Jul 17, 2025

Conversation

@mahdikhashan
Copy link
Member

@mahdikhashan mahdikhashan commented Jun 27, 2025

What type of PR is this?

Design Document

What this PR does / why we need it:

It explains the details for new feature called job-flow parameter overriding.

Which issue(s) this PR fixes:

part of #4275

Special notes for your reviewer:

TODO

Does this PR introduce a user-facing change?

TODO

Copilot AI review requested due to automatic review settings June 27, 2025 15:34
@volcano-sh-bot volcano-sh-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 27, 2025
Copilot AI reviewed Jun 27, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a design document for the new JobFlow parameter overriding feature, outlining motivation, user stories, and intended design sections.

  • Adds a new markdown file describing how users can reference and patch job-template parameters.
  • Provides summary, motivation, and user story placeholders.
  • Defines a Table of Contents and skeleton for design details.
Comments suppressed due to low confidence (3)

docs/design/jobflow/job-template-parameter-overriding.md:11

  • The TOC includes a link to the top-level section, which is redundant since it's the document title; consider removing this entry for clarity.
- [Job Template Parameter Overriding](#job-template-parameter-overriding)

docs/design/jobflow/job-template-parameter-overriding.md:34

  • The example code block is empty; please provide a representative YAML snippet illustrating how users override parameters in their FlowSpec.
```yaml

docs/design/jobflow/job-template-parameter-overriding.md:38

  • The 'Design Details' section is currently a placeholder; please flesh out the Data Structure and Queue State subsections as outlined in the TOC.
## Design Details

@volcano-sh-bot volcano-sh-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 27, 2025
lowang-bh
lowang-bh reviewed Jun 29, 2025
View reviewed changes
Copy link
Member

@lowang-bh lowang-bh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please squash your commits.

@mahdikhashan mahdikhashan force-pushed the jobflow-parameter-overrides branch from 4a62897 to bed2b1f Compare June 29, 2025 07:55
@mahdikhashan mahdikhashan requested a review from lowang-bh June 29, 2025 07:56
@mahdikhashan mahdikhashan force-pushed the jobflow-parameter-overrides branch from bed2b1f to 87b1b80 Compare June 29, 2025 07:56
@mahdikhashan
Copy link
Member Author

mahdikhashan commented Jun 29, 2025

please squash your commits.

done.

dongjiang1989
dongjiang1989 reviewed Jul 1, 2025
View reviewed changes
docs/design/jobflow/job-template-parameter-overriding.md
name: train-job
spec:
containers:
- name: cnn-mnist-torch
Copy link
Member

@dongjiang1989 dongjiang1989 Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there are multiple containers in a pod, should we replace it by name? If the name does not match, should we add the container?
@mahdikhashan

Copy link
Member

@dongjiang1989 dongjiang1989 Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other sections, such as volumes and envs

Copy link
Member Author

@mahdikhashan mahdikhashan Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, you are right. I'll review the proposal and adjust it considering this scenarios.

@mahdikhashan
Copy link
Member Author

mahdikhashan commented Jul 2, 2025

i addressed your feedback, please take a look when you have time @dongjiang1989
cc: @Monokaix

dongjiang1989
dongjiang1989 approved these changes Jul 3, 2025
View reviewed changes
Copy link
Member

@dongjiang1989 dongjiang1989 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@volcano-sh-bot volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label Jul 3, 2025
@dongjiang1989
Copy link
Member

dongjiang1989 commented Jul 3, 2025

BTW, Please fix DCO

@Monokaix
Copy link
Member

Monokaix commented Jul 3, 2025

Please merge to one clean commit: )

@mahdikhashan mahdikhashan force-pushed the jobflow-parameter-overrides branch from 95d8b22 to 238a6b9 Compare July 3, 2025 07:19
@volcano-sh-bot volcano-sh-bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 3, 2025
@mahdikhashan
Copy link
Member Author

mahdikhashan commented Jul 3, 2025

done.
cc: @Monokaix @dongjiang1989

@mahdikhashan
parameter override doc
b3aaba0 
Signed-off-by: mahdikhashan <[email protected]>
@mahdikhashan mahdikhashan force-pushed the jobflow-parameter-overrides branch from 238a6b9 to b3aaba0 Compare July 3, 2025 07:20
@Monokaix
Copy link
Member

Monokaix commented Jul 8, 2025

/cc @hwdef

@volcano-sh-bot volcano-sh-bot requested a review from hwdef July 8, 2025 01:41
@Monokaix
Copy link
Member

Monokaix commented Jul 17, 2025

/approve

@Monokaix
Copy link
Member

Monokaix commented Jul 17, 2025

/lgtm

@volcano-sh-bot
Copy link
Contributor

volcano-sh-bot commented Jul 17, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dongjiang1989, Monokaix

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:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@volcano-sh-bot volcano-sh-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 17, 2025
@volcano-sh-bot volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label Jul 17, 2025
@volcano-sh-bot volcano-sh-bot merged commit 99ccf33 into volcano-sh:master Jul 17, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@yuanchen8911 yuanchen8911 Awaiting requested review from yuanchen8911

@lowang-bh lowang-bh Awaiting requested review from lowang-bh

@dongjiang1989 dongjiang1989 Awaiting requested review from dongjiang1989

@hwdef hwdef Awaiting requested review from hwdef

Assignees

@dongjiang1989 dongjiang1989

@Monokaix Monokaix

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. retest-not-required-docs-only size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mahdikhashan @dongjiang1989 @Monokaix @volcano-sh-bot @lowang-bh