Skip to content

docs: Add multimodal architecture doc #1096

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

krishung5
Copy link
Contributor

@krishung5 krishung5 commented May 15, 2025

Overview:

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 new document outlining the Dynamo multimodal architecture, detailing support for text, image, and audio inputs, and explaining component roles and workflow for efficient large model inference.

@krishung5 krishung5 requested review from nnshah1 and statiraju May 15, 2025 17:33
Copy link

copy-pr-bot bot commented May 15, 2025

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.

@krishung5 krishung5 changed the title Add multimodal architecture doc doc: Add multimodal architecture doc May 15, 2025
@krishung5 krishung5 changed the title doc: Add multimodal architecture doc docs: Add multimodal architecture doc May 15, 2025
@github-actions github-actions bot added the docs label May 15, 2025
Copy link

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@github-actions github-actions bot added the Stale label Jun 15, 2025
Copy link
Contributor

coderabbitai bot commented Jun 15, 2025

Walkthrough

A new documentation file, docs/multimodal/architecture.md, has been introduced. This document outlines the Dynamo multimodal architecture, detailing its support for text, image, and audio inputs, and explaining the EPD Disaggregation approach for efficient inference. It describes component responsibilities and workflow, using the LLAVA model as an example.

Changes

File(s) Change Summary
docs/multimodal/architecture.md Added documentation describing the Dynamo multimodal architecture and its component workflow.

Suggested labels

documentation, size/L

Suggested reviewers

  • indrajit96
  • krishung5

Poem

In Dynamo’s world where inputs abound,
Text, images, and sounds swirl around.
With Encode, Prefill, Decode in play,
Multimodal magic finds its way.
A rabbit reads the docs with glee—
“Such clever architecture!” says he.
🐇✨


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
docs/multimodal/architecture.md (2)

2-3: Introduce an Overview section. The document jumps directly from the title to Motivation; adding a brief “## Overview” after the title to summarize key points would help readers orient themselves.


12-12: Hyphenate compound adjective in heading. Change “## High level architecture” to “## High-level architecture” for grammatical consistency.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...serving of large multimodal models. ## High level architecture Dynamo has already demons...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 889ab67 and c99e54f.

⛔ Files ignored due to path filters (1)
  • docs/images/multimodal_epd_disagg_workflow.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/multimodal/architecture.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/multimodal/architecture.md

[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...serving of large multimodal models. ## High level architecture Dynamo has already demons...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🪛 markdownlint-cli2 (0.17.2)
docs/multimodal/architecture.md

17-17: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

🔇 Additional comments (4)
docs/multimodal/architecture.md (4)

21-23: Client and Processor components well explained. Responsibilities for sending requests and handling I/O are clear and concise.


25-28: Decode Worker responsibilities are clear. The distinction between aggregation and disaggregated modes is well-defined.


29-32: Prefill Worker flow is accurate. The interaction with the Encode Worker and subsequent prefill steps are outlined clearly.


33-35: Encode Worker section is concise. The role in converting images to embeddings and forwarding them is well articulated.

Dynamo has already demonstrated [prefill-decode (PD) disaggregation](../disagg_serving.md) for efficient LLM serving. Building on that foundation, this proposal introduces a dedicated **encode worker** to handle the vision encoding step, fully separating the Encode, Prefill, and Decode phases.
The diagram below illustrates the proposed workflow, based on the LLAVA model ( image + text → text) with vLLM.

![](../images/multimodal_epd_disagg_workflow.png "Multimodal EPD Disaggregation Workflow")
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add alt text for accessibility. The image tag ![](../images/multimodal_epd_disagg_workflow.png "Multimodal EPD Disaggregation Workflow") lacks alt text. Replace with:

![Multimodal EPD Disaggregation Workflow](../images/multimodal_epd_disagg_workflow.png "Multimodal EPD Disaggregation Workflow")
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

17-17: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

🤖 Prompt for AI Agents
In docs/multimodal/architecture.md at line 17, the image markdown lacks alt text
which is important for accessibility. Add descriptive alt text by changing the
image tag from ![](../images/multimodal_epd_disagg_workflow.png "Multimodal EPD
Disaggregation Workflow") to include alt text like ![Multimodal EPD
Disaggregation Workflow](../images/multimodal_epd_disagg_workflow.png
"Multimodal EPD Disaggregation Workflow").

@github-actions github-actions bot removed the Stale label Jun 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant