Skip to content

[None][docs] fix multimodal chat client path in trtllm-serve docs - #18968

Closed
imitater-dou wants to merge 1 commit into
NVIDIA:mainfrom
imitater-dou:docs/fix-trtllm-serve-multimodal-chat-client
Closed

[None][docs] fix multimodal chat client path in trtllm-serve docs#18968
imitater-dou wants to merge 1 commit into
NVIDIA:mainfrom
imitater-dou:docs/fix-trtllm-serve-multimodal-chat-client

Conversation

@imitater-dou

@imitater-dou imitater-dou commented Sep 9, 2026

Copy link
Copy Markdown

Summary

  • trtllm-serve multimodal docs claimed only Chat API is supported, but the Sphinx literalinclude pointed at nonexistent examples/serve/openai_completion_client_for_multimodal.py.
  • Retarget the include to openai_chat_client_for_multimodal.py and correct the surrounding “Completions API” wording to “Chat API” (matching the existing curl_chat_client_for_multimodal.sh example).

Test plan

  • Confirmed examples/serve/openai_completion_client_for_multimodal.py is absent on main
  • Confirmed examples/serve/openai_chat_client_for_multimodal.py exists
  • Docs build / Sphinx literalinclude resolves

Dev Engineer Review

The documentation now references the existing openai_chat_client_for_multimodal.py example and uses “Chat API” terminology. No runtime behavior changes are expected. A Sphinx build remains recommended.

QA Engineer Review

No test changes.

Per-File QA Perspective

  • docs/source/commands/trtllm-serve/trtllm-serve.rst: Verify that the example link resolves and that the Chat API wording matches the supported multimodal serving interface.

Multimodal serving only supports Chat API; point the literalinclude at
openai_chat_client_for_multimodal.py (completion_* file does not exist).

Signed-off-by: ADou <ikun3.1415927@gmail.com>
@imitater-dou

Copy link
Copy Markdown
Author

Closing as superseded by #18967, which covers the same multimodal literalinclude path fix plus the base64 helper and bench doc link in the same file.

@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview 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: a3649a07-432e-44d3-a411-88419a791211

📥 Commits

Reviewing files that changed from the base of the PR and between 96a25c4 and e2b4dc6.

📒 Files selected for processing (1)
  • docs/source/commands/trtllm-serve/trtllm-serve.rst

Included review availability: Your plan provides up to 12 included reviews per hour; 6 remain after this review.


Walkthrough

The multimodal API documentation now references the OpenAI Chat API client example. The performance benchmarking reference remains unchanged.

Changes

Multimodal Chat API documentation

Layer / File(s) Summary
Update multimodal Chat API example reference
docs/source/commands/trtllm-serve/trtllm-serve.rst
The documentation now identifies Chat API usage and references openai_chat_client_for_multimodal.py. The performance benchmarking link remains unchanged.

Priority: ⚪ Not assessed

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

Merge Risk: ⚪ Minimal · up to e2b4d

Multimodal serving documentation now directs users to the supported Chat API client example. No current merge-blocking risk remains.

Suggested reviewers: bowenfu

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation fix and the affected multimodal chat client path. It is concise and directly related to the changes.
Description check ✅ Passed The description explains the documentation issue, the solution, and the verification performed. It identifies that the Sphinx documentation build remains pending, but the required summary and test inf…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.

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.

1 participant