docs: Reorganize Repository: migrate Multimodal #1913
Conversation
This change migrates the Multimodal example's documentation to the docs. folder.
whoisj
added
documentation
WalkthroughA new, detailed documentation file for multimodal model deployment with Dynamo was added under Changes
Possibly related PRs
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/examples/multimodal.md (2)
208-213: Resolve the lingering TODO
TODO: Apply Dynamo graph deployment for the exampleis still present. Either replace with the actual command/snippet or remove the placeholder to keep the docs production-ready.
101-109: Minor wording repetitionBack-to-back sentences starting with “If serving the example …” appear twice (image + video sections). Consider merging or rephrasing to reduce redundancy.
Also applies to: 249-251
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/examples/multimodal.md(1 hunks)examples/multimodal/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: biswapanda
PR: ai-dynamo/dynamo#1412
File: lib/bindings/python/src/dynamo/runtime/logging.py:100-100
Timestamp: 2025-06-06T21:48:35.214Z
Learning: In the Dynamo codebase, BentoML has been completely removed from all executable code, with only documentation and attribution references remaining. The error_loggers configuration in lib/bindings/python/src/dynamo/runtime/logging.py should not include "bentoml" since those modules no longer exist.
examples/multimodal/README.md (2)
Learnt from: biswapanda
PR: ai-dynamo/dynamo#1412
File: lib/bindings/python/src/dynamo/runtime/logging.py:100-100
Timestamp: 2025-06-06T21:48:35.214Z
Learning: In the Dynamo codebase, BentoML has been completely removed from all executable code, with only documentation and attribution references remaining. The error_loggers configuration in lib/bindings/python/src/dynamo/runtime/logging.py should not include "bentoml" since those modules no longer exist.
Learnt from: PeaBrane
PR: ai-dynamo/dynamo#1409
File: examples/router_standalone/worker.py:171-186
Timestamp: 2025-06-08T08:30:45.126Z
Learning: Example code in the `examples/` directory may intentionally use hard-coded values or simplified implementations that wouldn't be appropriate for production code, but are acceptable for demonstration and testing purposes.
🪛 LanguageTool
docs/examples/multimodal.md
[style] ~249-~249: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d with "Qwen/Qwen2.5-VL-7B-Instruct". If serving the example Phi3V model, replac...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (2)
examples/multimodal/README.md (1)
1-2: Symlink looks correct – no action neededThe relative target (
../../docs/examples/multimodal.md) resolves correctly fromexamples/multimodal/, so the symlink will work both locally and on GitHub.docs/examples/multimodal.md (1)
38-50: Inconsistent path forencode_workerlink
encode_workeris referenced twice with two different paths:- ../../examples/multimodal/encode_worker.py (bullet list) - ../../examples/multimodal/components/encode_worker.py (paragraph below)Please verify which path is valid and make the references consistent to avoid 404s in rendered docs.
- - workers: For aggregated serving, we have two workers, [encode_worker](../../examples/multimodal/encode_worker.py) ... + - workers: For aggregated serving, we have two workers, [encode_worker](../../examples/multimodal/components/encode_worker.py) ...
whoisj
changed the title
|
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. |
|
This PR has been closed due to inactivity. If you believe this PR is still relevant, please feel free to reopen it with additional context or information. |
This change is part of DYN-230 Reorganize Repository under which all documentation is to be moved under the
docs/folder with symlink files pointing into thedocs/folder placed where content was moved from.This change migrates the multimodal examples documentation.
DYN-230
Summary by CodeRabbit