docs: migrate Profiler docs to three-tier structure by dagil-nvidia · Pull Request #6003 · ai-dynamo/dynamo

dagil-nvidia · 2026-02-05T16:22:02Z

Summary

Create docs/components/profiler/ with Profiler component documentation
Add README.md with overview, feature matrix, and quick start examples
Add profiler_guide.md with detailed configuration, CLI arguments, and troubleshooting
Add cross-references from existing profiling docs to new location
Add Profiler to Components section in docs navigation

Test plan

Docs build locally using official method:

uv venv .venv-docs
uv pip install --python .venv-docs --group docs
uv run --python .venv-docs --no-project docs/generate_docs.py
# Output: "build succeeded."

CI docs build passes
Links render correctly in built docs

Summary by CodeRabbit

Documentation
- Added comprehensive Profiler documentation with quick-start guidance, configuration options, profiling methods, and usage examples.
- New Profiler component overview documenting features, prerequisites, and a comparison matrix.
- Added an in-depth Profiler guide covering deployment, integration, runtime profiling, WebUI, outputs, and troubleshooting.
- Expanded cross-references and added contextual "See also" notes to related profiling and benchmark docs for improved navigation.

Create docs/components/profiler/ with: - README.md: Overview, feature matrix, quick start - profiler_guide.md: Detailed configuration and usage Add cross-references from existing profiling docs: - docs/benchmarks/sla_driven_profiling.md - docs/backends/sglang/profiling.md Add Profiler to Components section in index.rst navigation. Signed-off-by: Dan Gil <dagil@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>

copy-pr-bot · 2026-02-05T16:22:06Z

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

coderabbitai · 2026-02-05T16:25:49Z

Walkthrough

Adds a new Profiler component documentation (README and detailed guide), updates the site index to include the profiler, and inserts "See also" cross-reference notes into two existing docs. No code, API, or runtime behavior changes.

Changes

Cohort / File(s)	Summary
Profiler docs (new) `docs/components/profiler/README.md`, `docs/components/profiler/profiler_guide.md`	Added comprehensive Profiler documentation: overview, feature matrix, quick-starts, deployment (DGDR/Kubernetes & direct script), configuration options, profiling methods, integration, outputs, examples and troubleshooting.
Cross-reference updates `docs/backends/sglang/profiling.md`, `docs/benchmarks/sla_driven_profiling.md`	Inserted "See also" note blocks referencing the new Profiler Component Overview immediately after existing guidance sections.
Navigation index `docs/index.rst`	Added Profiler entry under the Components toctree to expose new documentation in site navigation.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I hopped through docs at break of dawn,

Added guides so profiling's drawn.
Links now lead where insights glow,
Pipelines hum and metrics grow.
A tiny rabbit says: onward we go! 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main objective of migrating Profiler documentation to a three-tier structure.
Description check	✅ Passed	The description covers all required template sections: Overview/Summary, Details, Where to review, and Related Issues with appropriate context.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

dagil-nvidia · 2026-02-05T16:33:41Z

/ok to test 2a00679

dagil-nvidia · 2026-02-05T17:00:00Z

@coderabbitai full review

coderabbitai · 2026-02-05T17:00:11Z

✅ Actions performed

Full review triggered.

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/components/profiler/README.md`:
- Around line 110-114: The fenced code block under "Example recommendations" is
missing a language tag (MD040); update the triple-backtick fence for that block
to include a language identifier (e.g., use ```text) so the block becomes a
labeled fenced code block, preserving the two recommendation lines inside (the
lines starting "Suggested prefill TP:4 ..." and "Suggested decode TP:4 ...").

docs/components/profiler/README.md

Address CodeRabbit review: add text language identifier to Example recommendations code block (MD040). Signed-off-by: Dan Gil <dagil@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>

dagil-nvidia · 2026-02-05T17:05:49Z

/ok to test b25ed19

docs/benchmarks/sla_driven_profiling.md

docs/components/profiler/README.md

Expand profiler documentation by absorbing content from sla_driven_profiling.md and planner quickstart (non-destructive, originals kept): - profiler_guide.md: full config reference, profiling methods, DGDR workflow, parallelization sweep internals, troubleshooting - profiler_examples.md: complete DGDR YAMLs (dense, AIC, MoE, ConfigMap), WebUI usage, direct script examples - README.md: updated Next Steps and toctree Signed-off-by: Dan Gil <dagil@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>

dagil-nvidia · 2026-02-05T19:20:53Z

/ok to test b20506f

Jont828

Took an initial pass through. Besides nits/typos, the main questions for me are about what the valid fields and values are for arguments that go into the python script and the K8s fields and how to pick the correct values for them.

docs/components/profiler/profiler_examples.md

docs/components/profiler/profiler_guide.md

docs/components/profiler/README.md

docs/components/profiler/profiler_examples.md

docs/components/profiler/profiler_guide.md

@Jont828

- Add SPDX copyright headers to all 3 files (@Jont828) - Add supported systems comment to AIC example (@Jont828) - Use concrete disagg.yaml path in script example (@Jont828) - Clarify gpuType vs aicSystem distinction (@Jont828) - Add CLI-to-DGDR argument mapping note (@Jont828) - Clarify aicBackendVersion meaning with link (@Jont828) Signed-off-by: Dan Gil <dagil@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>

dagil-nvidia · 2026-02-05T23:33:02Z

/ok to test 5ff23d4

Co-authored-by: Jonathan Tong <jt572@cornell.edu> Signed-off-by: dagil-nvidia <dagil@nvidia.com>

dagil-nvidia · 2026-02-05T23:38:20Z

/ok to test b0a107e

Jont828 · 2026-02-05T23:39:48Z

^ My review comments are non-blocking btw. We can merge this asap to avoid too many rebase issues but figured it'd be good to have to follow up later.

Signed-off-by: Dan Gil <dagil@nvidia.com> Signed-off-by: dagil-nvidia <dagil@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: Jonathan Tong <jt572@cornell.edu>

pull-request-size bot added the size/L label Feb 5, 2026

github-actions bot added docs documentation Improvements or additions to documentation labels Feb 5, 2026

dagil-nvidia changed the title ~~docs: add Profiler component documentation~~ docs: migrate Profiler to three-tier docs structure Feb 5, 2026

dagil-nvidia requested a review from hhzhang16 February 5, 2026 16:27

dagil-nvidia changed the title ~~docs: migrate Profiler to three-tier docs structure~~ docs: migrate Profiler docs to three-tier structure Feb 5, 2026

coderabbitai bot reviewed Feb 5, 2026

View reviewed changes

docs/components/profiler/README.md Show resolved Hide resolved

fix: add language tag to fenced code block

b25ed19

Address CodeRabbit review: add text language identifier to Example recommendations code block (MD040). Signed-off-by: Dan Gil <dagil@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>

hhzhang16 reviewed Feb 5, 2026

View reviewed changes

docs/benchmarks/sla_driven_profiling.md Show resolved Hide resolved

docs/components/profiler/README.md Show resolved Hide resolved

pull-request-size bot added size/XXL and removed size/L labels Feb 5, 2026

hhzhang16 approved these changes Feb 5, 2026

View reviewed changes

Jont828 reviewed Feb 5, 2026

View reviewed changes

docs/components/profiler/profiler_guide.md Outdated Show resolved Hide resolved

Update docs/components/profiler/profiler_examples.md

b0a107e

Co-authored-by: Jonathan Tong <jt572@cornell.edu> Signed-off-by: dagil-nvidia <dagil@nvidia.com>

dagil-nvidia merged commit 3023c62 into main Feb 6, 2026
33 checks passed

dagil-nvidia deleted the dagil/docs-profiler-migration branch February 6, 2026 00:05

dagil-nvidia mentioned this pull request Feb 6, 2026

docs: cleanup of docs refactor for components, integrations, and features #6019

Merged

8 tasks

Conversation

dagil-nvidia commented Feb 5, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Related

Summary by CodeRabbit

Uh oh!

copy-pr-bot bot commented Feb 5, 2026

Uh oh!

coderabbitai bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

dagil-nvidia commented Feb 5, 2026

Uh oh!

dagil-nvidia commented Feb 5, 2026

Uh oh!

coderabbitai bot commented Feb 5, 2026

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dagil-nvidia commented Feb 5, 2026

Uh oh!

Uh oh!

Uh oh!

dagil-nvidia commented Feb 5, 2026

Uh oh!

Jont828 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dagil-nvidia commented Feb 5, 2026

Uh oh!

dagil-nvidia commented Feb 5, 2026

Uh oh!

Jont828 commented Feb 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dagil-nvidia commented Feb 5, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 5, 2026 •

edited

Loading

Jont828 left a comment •

edited

Loading