Skip to content

docs: update batch job execution description to the new design - #626

Merged
zdtsw merged 3 commits into
llm-d:mainfrom
evacchi:update-docs
Aug 10, 2026
Merged

docs: update batch job execution description to the new design#626
zdtsw merged 3 commits into
llm-d:mainfrom
evacchi:update-docs

Conversation

@evacchi

@evacchi evacchi commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Why is this PR needed?

#581 and #584 introduced changes that are no longer reflected in the documentation

What does this PR do?

Update the stale design docs with the changes introduced in #581 and #584

How was this tested?

  • Unit tests added/updated/verified
  • Integration/e2e tests added/updated/verified
  • Manual testing performed

Checklist

  • Commits are signed off (git commit -s) per DCO
  • Code follows project contributing guidelines
  • CI checks pass (make ci)
  • E2E tests pass (make test-e2e)

Related Issues

#581 and #584

Copilot AI review requested due to automatic review settings July 29, 2026 13:16
@github-actions github-actions Bot added the documentation Documentation, README, or guides only label Jul 29, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the batch gateway design documentation to reflect the channel-based execution pipeline introduced in #581/#584, clarifying how sync vs async dispatch are realized as different leaf dispatchers in the same pipeline and updating the llm-d-async queue naming/consumption description accordingly.

Changes:

  • Refreshes the batch dispatcher queue design doc to match the current async integration (AsyncDispatcher leaf, broadcaster-based result fanout, suffix-less result queue naming).
  • Updates the batch processor architecture doc to describe the new channel-based pipeline actors (RequestSource → dispatcher chain → ResultCollector) and revised scheduling/concurrency semantics.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/design/batch-dispatcher-queue-design.md Updates async queue naming and result-consumption design to match the new pipeline-based implementation.
docs/design/batch_processor_architecture.md Reworks the execution/scheduling sections to document the channel-based pipeline design introduced in #581/#584.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@j-mok-dev j-mok-dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm. I see that this PR still documents the 4-context model, but #625 changes it to a single abort context with batchctx.Cause. Maybe we can merge #625 first then rebase this PR, and update the Context Hierarchy section again with the batchctx-based context.

@evacchi

evacchi commented Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

agreed!

@evacchi

evacchi commented Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

the text now includes the description of the changes detailed in #625, so it should be merged after that.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

Unsigned commits detected! Please sign your commits.

For instructions on how to set up GPG/SSH signing and verify your commits, please see GitHub Documentation.

Signed-off-by: Edoardo Vacchi <evacchi@users.noreply.github.com>
Signed-off-by: Edoardo Vacchi <evacchi@users.noreply.github.com>
@evacchi
evacchi requested a review from zdtsw as a code owner August 10, 2026 08:55
@zdtsw
zdtsw enabled auto-merge (squash) August 10, 2026 09:00
@zdtsw
zdtsw merged commit 306f401 into llm-d:main Aug 10, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation, README, or guides only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants