Add a deprecation notice for trtllm export in doc

[Edwardf0t1]

What does this PR do?

Type of change: Doc update

Overview: Add a deprecation notice for trtllm export in doc.

Usage

# Add a code snippet demonstrating how to use this

Testing

Before your PR is "Ready for review"

• Make sure you read and follow Contributor guidelines and your commits are signed.
• Is this change backward compatible?: Yes/No
• Did you write any new necessary tests?: Yes/No
• Did you add or update any necessary documentation?: Yes/No
• Did you update Changelog?: Yes/No

Additional Information

Summary by CodeRabbit

• Documentation
  • Added a deprecation notice for export_tensorrt_llm_checkpoint, advising migration to the unified Hugging Face export API.
  • Updated workflow and build API references to legacy locations.
  • Added an overview noting ModelOpt can automatically convert ModelOpt-exported LLM checkpoints into TensorRT-LLM checkpoints and engines.
  • Clarified prerequisites and improved guidance to streamline migration and setup for TensorRT-LLM users.

[coderabbitai]

Walkthrough

Added deprecation notice and migration guidance for export_tensorrt_llm_checkpoint, updated internal reference URLs to legacy paths, and added an introductory note that ModelOpt can automatically convert ModelOpt-exported LLM checkpoints to TensorRT-LLM checkpoints and engines.

Changes

Cohort / File(s)	Summary of Changes
Docs: TensorRT-LLM deployment guide docs/source/deployment/1_tensorrt_llm.rst	Added a deprecation notice for export_tensorrt_llm_checkpoint with migration guidance to the unified HF export API; updated TensorRT-LLM workflow and build API reference links to legacy/... paths; added an introductory paragraph noting ModelOpt supports automatic conversion of ModelOpt-exported LLMs to TensorRT-LLM checkpoints and engines.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I nibbled through docs by the lamp’s soft glow,
“Deprecated” I scribbled, then hopped to and fro.
ModelOpt whispers, “I’ll weave your new keys,”
Checkpoints turned engines with effortless ease. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title succinctly conveys the primary update of adding a deprecation notice for the trtllm export in the documentation and directly matches the changes made. It refrains from generic or vague language and focuses specifically on the main purpose of the PR. This clarity ensures that anyone reviewing the commit history can immediately understand the intent without reading the full diff. Therefore, the title meets the criteria for clarity, relevance, and conciseness.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch zhiyu/update-docs-trtllm-export

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 87171ad and 89d7937.

📒 Files selected for processing (1)

• docs/source/deployment/1_tensorrt_llm.rst (2 hunks)

⏰ 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). (3)

• GitHub Check: linux
• GitHub Check: code-quality
• GitHub Check: build-docs

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/source/deployment/1_tensorrt_llm.rst (1)

5-6: Use Sphinx’s .. deprecated:: directive instead of bold text

Sphinx provides a first-class .. deprecated:: admonition that adds consistent styling and version metadata to the doc build. Please switch to that directive (with the appropriate version) so the deprecation is surfaced uniformly in HTML/PDF outputs.

-**Deprecation Notice**: The export_tensorrt_llm_checkpoint API will be deprecated in future releases. Users are encouraged to transition to the :doc:`unified HF export API <3_unified_hf>`, which provides enhanced functionality and flexibility for exporting models to multiple inference frameworks including TensorRT-LLM, vLLM, and SGLang.
+.. deprecated:: <version>
+   The :meth:`export_tensorrt_llm_checkpoint <modelopt.torch.export.model_config_export.export_tensorrt_llm_checkpoint>` API will be removed in an upcoming release. Transition to the :doc:`unified HF export API <3_unified_hf>` for expanded export coverage across TensorRT-LLM, vLLM, and SGLang.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1537885 and 44c5c92.

📒 Files selected for processing (1)

• docs/source/deployment/1_tensorrt_llm.rst (1 hunks)

⏰ 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). (2)

• GitHub Check: build-docs
• GitHub Check: code-quality

[cjluo-nv]

I recommend we fully deprecate this page and move the hf checkpoint page to be the default. We might want to update the supported models for TRT LLM as well.

[Edwardf0t1]

I recommend we fully deprecate this page and move the hf checkpoint page to be the default. We might want to update the supported models for TRT LLM as well.

Let's please do that when the trt-llm export related code is fully removed in hf_ptq examples.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.36%. Comparing base (1537885) to head (89d7937).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #410      +/-   ##
==========================================
- Coverage   73.79%   73.36%   -0.44%     
==========================================
  Files         171      180       +9     
  Lines       17591    17919     +328     
==========================================
+ Hits        12982    13146     +164     
- Misses       4609     4773     +164     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.