Skip to content

[None][doc] Add overlap scheduler pipeline diagram - #17478

Open
Satyamkale123 wants to merge 2 commits into
NVIDIA:mainfrom
Satyamkale123:docs/overlap-scheduler-diagram
Open

[None][doc] Add overlap scheduler pipeline diagram#17478
Satyamkale123 wants to merge 2 commits into
NVIDIA:mainfrom
Satyamkale123:docs/overlap-scheduler-diagram

Conversation

@Satyamkale123

@Satyamkale123 Satyamkale123 commented Aug 10, 2026

Copy link
Copy Markdown

Description

The Overlap Scheduler section explains how GPU forward passes for step N+1
run concurrently with CPU result processing for step N, but the concept is
described only in text and code.

This diagram provides a visual timeline showing the GPU/CPU overlap pattern,
making it easier for new contributors to quickly grasp the pipelining strategy
that enables higher throughput.

Changes

  • Added overlap_scheduler_pipeline.png to docs/source/media/
  • Updated docs/source/features/overlap-scheduler.md to include the diagram

Type of change

  • Documentation update

Dev Engineer Review

  • Added overlap_scheduler_pipeline.png to the documentation media directory.
  • Embedded the diagram in overlap-scheduler.md.
  • The diagram shows concurrent GPU forward passes and CPU result processing.
  • No code, API, configuration, or test-list changes require review.

QA Engineer Review

No test changes.

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 8c547e6d-f935-4cb3-9a76-a78697eb5f8d

📥 Commits

Reviewing files that changed from the base of the PR and between 23fb9a2 and a548ff9.

📒 Files selected for processing (1)
  • docs/source/features/overlap-scheduler.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/source/features/overlap-scheduler.md

Walkthrough

The overlap scheduler documentation now includes an Apache-2.0 SPDX header and a pipeline diagram that illustrates concurrent CPU and GPU execution.

Changes

Overlap Scheduler Documentation

Layer / File(s) Summary
Update overlap scheduler documentation
docs/source/features/overlap-scheduler.md
Adds the Apache-2.0 SPDX header and the Overlap Scheduler Pipeline diagram.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: arysef, nv-guomingz

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies a documentation change that adds an overlap scheduler pipeline diagram.
Description check ✅ Passed The description explains the purpose and changes, but it omits test coverage and the PR checklist; these omissions are non-critical for this documentation-only change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/source/features/overlap-scheduler.md`:
- Around line 12-13: Add the repository-standard NVIDIA copyright header at the
beginning of the overlap scheduler documentation, before the title and existing
content, using the latest meaningful modification year. Preserve the document’s
current content and formatting after the header.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: c214a2c3-e1dc-4f3b-9338-0308d9c73151

📥 Commits

Reviewing files that changed from the base of the PR and between c67879c and 23fb9a2.

⛔ Files ignored due to path filters (1)
  • docs/source/media/overlap_scheduler_pipeline.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/source/features/overlap-scheduler.md

Comment thread docs/source/features/overlap-scheduler.md
@Satyamkale123
Satyamkale123 force-pushed the docs/overlap-scheduler-diagram branch from 23fb9a2 to 7762edf Compare August 10, 2026 21:44
Signed-off-by: SATYAM AJIT KALE <satyamkale222@gmail.com>
@Satyamkale123
Satyamkale123 force-pushed the docs/overlap-scheduler-diagram branch from a548ff9 to c09b998 Compare August 10, 2026 21:53

@brnguyen2 brnguyen2 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.

Approving — the comments below are optional touch-ups, not blockers.

Diagram is accurate and legible, and it matches the text and code snippet below it. Two small things:

  • The SPDX header isn't mentioned in the description and isn't part of adding a diagram. If you keep it, use 2026 to match the convention in docs/source/features/model-express.md rather than 2022-2026 (this file wasn't created in 2022).
  • No source file for the PNG is checked in, so the next person to edit it has to redraw it. See the inline note.

Comment thread docs/source/features/overlap-scheduler.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants