docs: add a doc for framework lib versions #3572

biswapanda · 2025-10-13T01:25:04Z

Overview:

add a doc for framework lib versions

Details:

Where should the reviewer start?

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

closes GitHub issue: #xxx

Summary by CodeRabbit

Documentation
- Added a centralized reference detailing framework and dependency versions, base container images, framework-specific configurations, and container build/run workflows for NVIDIA Dynamo.
- Covers core dependencies (e.g., vLLM, TensorRT-LLM, FlashInfer, NIXL, UCX), CUDA versions, integration flags, build locations, and Python requirements.
- Includes notes on usage variability across frameworks and links to container documentation.
- Improves clarity and traceability for environment setup and maintenance.

biswapanda · 2025-10-13T01:27:02Z

/ok to test 51d3cb6

coderabbitai · 2025-10-13T01:28:18Z

Walkthrough

Added FRAMEWORK_VERSIONS.md documenting core dependencies, versions, base images, framework configurations, dependency management artifacts, notes on variability, and container documentation references for NVIDIA Dynamo.

Changes

Cohort / File(s)	Summary
Documentation `FRAMEWORK_VERSIONS.md`	New Markdown doc centralizing dependency versions (vLLM, TensorRT-LLM, FlashInfer, NIXL, UCX), CUDA base images/tags, framework-specific configs, build scripts/requirements, usage notes, and container docs references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my ears at version notes so grand,
A map of CUDA seas and frameworks planned.
From vLLM to UCX we hop in line,
Tags and builds all neatly now align.
With docs in paw, I bound with cheer—
Dependency trails are crystal clear! 🐇✨

Pre-merge checks

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The description uses the required template headings but leaves essential sections such as Details and Where should the reviewer start empty, and the issue reference remains a placeholder. Because of these omissions the pull request description lacks the information reviewers need to understand what was changed and where to focus.	Please fill in the Details section with a summary of the actual changes, specify which files or areas reviewers should examine in the Where should the reviewer start section, and replace the placeholder issue number with the correct issue reference.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title clearly and concisely indicates that a documentation file for framework library versions is being added, matching the primary purpose of the changeset. It follows the conventional “docs:” prefix and provides enough specificity for reviewers to understand the main change at a glance.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 90dc758 and 8fe5c37.

📒 Files selected for processing (1)

FRAMEWORK_VERSIONS.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Build and Test - dynamo

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.}

biswapanda · 2025-10-13T01:29:08Z

/ok to test a76a621

coderabbitai · 2025-10-13T01:30:09Z

Walkthrough

Adds a new documentation file, FRAMEWORK_VERSIONS.md, detailing core frameworks and versions, base CUDA images, framework-specific configurations (vLLM, TensorRT-LLM, SGLang), dependency management locations (build scripts, wheels, requirements), notes on version usage, and container documentation references.

Changes

Cohort / File(s)	Summary
Documentation `FRAMEWORK_VERSIONS.md`	New doc centralizing versions and configs: core dependencies (vLLM v0.11.0, TensorRT-LLM 1.1.0rc5, FlashInfer v0.3.1, NIXL 0.6.0, UCX v1.19.0), base CUDA images (12.8/12.8.1), framework-specific settings (incl. build locations), dependency management paths, notes, and container references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I thump my paws—versions aligned, neat, terse,
CUDA moons shine on our containerverse.
vLLM hops, TensorRT-LLM sprints,
FlashInfer sparkles with speedy hints.
In one burrowed page, the map unfurls—
wheels, scripts, notes for all our whirls.
Carrot-commit: docs guide our worlds. 🥕

Pre-merge checks

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description includes the required headings but leaves the Details and Where should the reviewer start sections empty and uses a placeholder issue number in Related Issues, so critical information is missing for a thorough review.	Please fill in the Details section with a summary of the changes, specify relevant files in the Where should the reviewer start section, and replace the placeholder issue number with the actual GitHub issue to be closed.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title clearly summarizes the main change of adding documentation for framework library versions and follows the concise, imperative style expected for docs updates.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

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.}

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 90dc758 and a76a621.

📒 Files selected for processing (1)

FRAMEWORK_VERSIONS.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Build and Test - dynamo

FRAMEWORK_VERSIONS.md

alec-flowers · 2025-10-13T21:32:59Z

Any way we can generate this automatically? vs. having to manually update? I think that would make our lives easier and could be part of the release process. I think @dagil-nvidia worked on something tangentially related.

alec-flowers · 2025-10-13T21:34:06Z

I also think some of this should be covered in a release / support matrix that is floating around somewhere.

alec-flowers · 2025-10-13T21:34:29Z

See -

dynamo/docs/support_matrix.md

Line 7 in d4ff6f0

# Dynamo Support Matrix

Created automated generator for framework versions documentation: Generator Script (.github/scripts/dependency-extraction/generate_framework_versions.py): - Dynamically generates FRAMEWORK_VERSIONS.md from dependency CSV - Shows both latest (main) and last release versions side-by-side - Auto-detects most recent release snapshot for comparison - Highlights version differences between main and release - Extracts critical dependencies, base images, and framework configs - Organizes by component (vLLM, TensorRT-LLM, SGLang) Key Features: - Auto-generated from dependency_versions_latest.csv (262 total deps) - Displays 55 critical dependencies with versions - Shows 21 base/runtime images with tags - Compares latest vs release when available - Includes statistics (total deps, critical count, NVIDIA products) - Links to dependency reports and container documentation Workflow Integration: - Runs nightly after dependency extraction - Generates FRAMEWORK_VERSIONS.md in repo root - Included in automated PR when dependency changes detected - Provides easy reference for framework versions This addresses PR #3572 request for framework versions doc, but implements it dynamically instead of manually maintained. Benefits over manual approach: - Always up-to-date (runs nightly) - Automatically detects version changes - Shows version differences (latest vs release) - Sourced from single source of truth (dependency CSV) - No risk of manual updates being stale Files Generated: - FRAMEWORK_VERSIONS.md (438 lines, auto-generated) - Example also saved to ~/Desktop/FRAMEWORK_VERSIONS.md Related: #DYN-1235, PR #3572 Signed-off-by: Dan Gil <[email protected]>

dagil-nvidia · 2025-10-22T04:45:09Z

To match other docs, would recommend the doc be named framework_versions.md.

@nv-anants

Implements comprehensive dependency tracking across all Dynamo components with full modularization, unit tests, and automated documentation generation. Core System: - Automated extraction from 10 source types - Nightly workflow with smart PR creation - Release snapshot system - Version discrepancy detection - Automated failure monitoring Modular Architecture (1,900+ lines extracted): - constants.py: Centralized hardcoded values - utils/: formatting, comparison, URL generation - extractors/: Base class + Python extractor (pattern for future) - tests/: 145+ unit tests (@pytest.mark.weekly) Documentation: - framework_versions.md: Auto-generated framework versions (101 lines) - .github/reports/README.md: CSV structure and workflows - .github/scripts/dependency-extraction/README.md: Architecture (290 lines) Workflows: - Unified dependency-extraction.yml (nightly + release modes) - Composite action for reusable setup - Auto-creates GitHub issues on failure Files (22 total): - 18 new files (scripts, config, docs, tests, modules) - 1 modified (.gitignore) - 1 generated (dependency_versions_latest.csv) - 1 auto-generated (framework_versions.md) Testing: - 145+ unit tests with proper pytest markers - Tests run weekly (non-blocking) - Coverage for formatting and Python extractor Addresses: - DYN-1235: Automated dependency tracking - PR #3572: Framework versions doc (but auto-generated) - Review feedback from @nv-anants (all 6 comments) Supersedes: PR #3547 (had merge conflicts and unrelated files) Signed-off-by: Dan Gil <[email protected]>

pull-request-size bot added the size/M label Oct 13, 2025

ai-dynamo deleted a comment from coderabbitai bot Oct 13, 2025

docs: add a doc for framework lib versions

a76a621

biswapanda force-pushed the bis/vllm-k8s-e2e-test branch from 51d3cb6 to a76a621 Compare October 13, 2025 01:28

biswapanda changed the title ~~doc: add a doc for framework lib versions~~ docs: add a doc for framework lib versions Oct 13, 2025

github-actions bot added the docs label Oct 13, 2025

biswapanda self-assigned this Oct 13, 2025

coderabbitai bot reviewed Oct 13, 2025

View reviewed changes

FRAMEWORK_VERSIONS.md Outdated Show resolved Hide resolved

biswapanda requested a review from alec-flowers October 13, 2025 15:52

biswapanda changed the title ~~docs: add a doc for framework lib versions~~ docs: for framework lib versions Oct 13, 2025

biswapanda changed the title ~~docs: for framework lib versions~~ docs: add a doc for framework lib versions Oct 13, 2025

fix

8fe5c37

biswapanda requested review from atchernych, mohammedabdulwahhab and tmonty12 October 13, 2025 20:56

dagil-nvidia mentioned this pull request Oct 22, 2025

feat: add automated dependency tracking and extraction system #3806

Open

biswapanda closed this Oct 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add a doc for framework lib versions #3572

docs: add a doc for framework lib versions #3572

Uh oh!

biswapanda commented Oct 13, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

biswapanda commented Oct 13, 2025

Uh oh!

coderabbitai bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

biswapanda commented Oct 13, 2025

Uh oh!

coderabbitai bot commented Oct 13, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

alec-flowers commented Oct 13, 2025

Uh oh!

alec-flowers commented Oct 13, 2025

Uh oh!

alec-flowers commented Oct 13, 2025

Uh oh!

dagil-nvidia commented Oct 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

docs: add a doc for framework lib versions #3572

docs: add a doc for framework lib versions #3572

Uh oh!

Conversation

biswapanda commented Oct 13, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview:

Details:

Where should the reviewer start?

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

Summary by CodeRabbit

Uh oh!

biswapanda commented Oct 13, 2025

Uh oh!

coderabbitai bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks

Uh oh!

biswapanda commented Oct 13, 2025

Uh oh!

coderabbitai bot commented Oct 13, 2025

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alec-flowers commented Oct 13, 2025

Uh oh!

alec-flowers commented Oct 13, 2025

Uh oh!

alec-flowers commented Oct 13, 2025

Uh oh!

dagil-nvidia commented Oct 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

biswapanda commented Oct 13, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 13, 2025 •

edited

Loading