doc: fix invalid links related with llm api example #6317
Conversation
📝 WalkthroughWalkthroughThis update corrects relative file paths to example scripts in documentation files for the Llama model (PyTorch backend), DeepSeek-V3, and Qwen3. The changes ensure that references to quickstart example scripts point to their correct locations, improving documentation accuracy. No functional or code logic changes were made. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (3)
⏰ 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)
✨ Finishing Touches🧪 Generate unit tests
🪧 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: 1
🔭 Outside diff range comments (1)
examples/models/core/deepseek_v3/README.md (1)
80-85: Relative path off by two levelsFrom
examples/models/core/deepseek_v3/README.md, the link needs three..segments to reachexamples/llm-api, not one.-To quickly run DeepSeek-V3, [examples/llm-api/quickstart_advanced.py](../llm-api/quickstart_advanced.py): +To quickly run DeepSeek-V3, [examples/llm-api/quickstart_advanced.py](../../../llm-api/quickstart_advanced.py):
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/source/torch.md(1 hunks)examples/models/core/deepseek_v3/README.md(2 hunks)examples/models/core/qwen/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/source/torch.md (1)
Learnt from: yechank-nvidia
PR: #6254
File: tensorrt_llm/_torch/pyexecutor/model_engine.py:1201-1204
Timestamp: 2025-07-22T09:22:14.726Z
Learning: In TensorRT-LLM's multimodal processing pipeline, shared tensor recovery using from_shared_tensor() is only needed during the context phase. Generation requests reuse the already-recovered tensor data and only need to call strip_for_generation() to remove unnecessary multimodal data while preserving the recovered tensors. This avoids redundant tensor recovery operations during generation.
🪛 markdownlint-cli2 (0.17.2)
examples/models/core/deepseek_v3/README.md
80-80: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🔇 Additional comments (2)
examples/models/core/qwen/README.md (1)
627-631: Link update LGTMThe new relative path (
../../../llm-api/quickstart_advanced.py) correctly resolves fromexamples/models/core/qwen/README.mdback toexamples/llm-api/quickstart_advanced.py.
No further action required.examples/models/core/deepseek_v3/README.md (1)
97-101: Good catch on second linkThis second reference already uses
../../../llm-api/quickstart_advanced.pyand is therefore correct.
|
/bot run --stage-list "A10-Build_Docs" |
nv-guomingz
force-pushed
the
user/guomingz/fix_doc_example
branch
from
85bb76f to
91da752
Compare
coderabbitai
bot
added
the
Doc
nv-guomingz
force-pushed
the
user/guomingz/fix_doc_example
branch
from
91da752 to
e7433d1
Compare
|
PR_Github #12787 [ run ] triggered by Bot |
|
PR_Github #12787 [ run ] completed with state |
Signed-off-by: nv-guomingz <[email protected]>
nv-guomingz
force-pushed
the
user/guomingz/fix_doc_example
branch
from
e7433d1 to
f3e0d2d
Compare
|
/bot skip --comment "docs change, build phase already passed" |
|
PR_Github #12795 [ skip ] triggered by Bot |
|
PR_Github #12795 [ skip ] completed with state |
Signed-off-by: nv-guomingz <[email protected]> Signed-off-by: Shreyas Misra <[email protected]>
Signed-off-by: nv-guomingz <[email protected]> Signed-off-by: Ransiki Zhang <[email protected]>
Signed-off-by: nv-guomingz <[email protected]> Signed-off-by: Lanyu Liao <[email protected]>
Fix the issue that our doc doesn't show code snippets which raised by #5736
Summary by CodeRabbit