[None][docs] fix multimodal serve client path, base64 util, and bench doc link - #18967
[None][docs] fix multimodal serve client path, base64 util, and bench doc link#18967imitater-dou wants to merge 1 commit into
Conversation
… doc link Signed-off-by: ADou <ikun3.1415927@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 12 included reviews per hour; 7 remain after this review. WalkthroughThe serving documentation updates the multimodal Chat API example, image base64 encoding utility reference, and performance benchmarking link. ChangesServing documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This change updates serving documentation to point users to the current multimodal Chat API example, base64 image helper, and benchmarking guide. The referenced targets are present and aligned with the documented workflows, with no remaining merge-readiness risk. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
brnguyen2
left a comment
There was a problem hiding this comment.
Approving — the comments below are optional touch-ups, not blockers.
Verified all three claims against the tree: examples/serve/openai_chat_client_for_multimodal.py exists (no completion-variant multimodal client), encode_base64_image is exported from tensorrt_llm/inputs/__init__.py and defined in inputs/utils.py:272, and docs/source/commands/trtllm-serve/run-benchmark-with-trtllm-serve.md exists. Fixes are correct.
One thing to fix before merge (inline). Optionally, since the benchmark doc is in the same docs tree, :doc: (:doc:`run-benchmark-with-trtllm-serve`) would be a versioned in-tree link instead of a hardcoded main blob URL.
|
|
||
| Besides the above examples, `trtllm-serve` is also used as an entrypoint for performance benchmarking. | ||
| Please refer to `Performance Benchmarking with `trtllm-serve` <https://github.com/NVIDIA/TensorRT-LLM/blob/main/docs/source/commands/trtllm-serve/trtllm-serve-bench.md>` for more details. | ||
| Please refer to `Performance Benchmarking with trtllm-serve <https://github.com/NVIDIA/TensorRT-LLM/blob/main/docs/source/commands/trtllm-serve/run-benchmark-with-trtllm-serve.md>`__ for more details. No newline at end of file |
There was a problem hiding this comment.
This drops the trailing newline at EOF. .pre-commit-config.yaml enables end-of-file-fixer with no .rst exclusion, so this will be modified by the hook (and fail the pre-commit CI check). Re-add the newline, or run pre-commit run --files docs/source/commands/trtllm-serve/trtllm-serve.rst and re-stage.
Summary
examples/serve/openai_chat_client_for_multimodal.py(ghost completion client path).tensorrt_llm.inputs.encode_base64_image.run-benchmark-with-trtllm-serve.md.Test plan
examples/serve/openai_chat_client_for_multimodal.pyexists and the old completion multimodal path does not.encode_base64_imageis exported fromtensorrt_llm.inputs.docs/source/commands/trtllm-serve/run-benchmark-with-trtllm-serve.mdexists.enable_overlap_scheduler.Dev Engineer Review
docs/source/commands/trtllm-serve/trtllm-serve.rstto use the correct multimodal Chat API example path.tensorrt_llm.inputs.encode_base64_image.QA Engineer Review
No test changes.
Per-File QA Perspective
docs/source/commands/trtllm-serve/trtllm-serve.rst: Documentation-only changes. Verify that the referenced example file,tensorrt_llm.inputs.encode_base64_imageexport, and benchmarking document resolve correctly.