[TRTLLM-8763][chore] Deprecate pybind based GuidedDecodingConfig usage in torch backend #8717
Conversation
…e in torch backend Signed-off-by: leslie-fang25 <[email protected]>
|
/bot run --disable-fail-fast |
|
PR_Github #22748 [ run ] triggered by Bot. Commit: |
|
PR_Github #22748 [ run ] completed with state |
📝 WalkthroughWalkthroughGuidedDecodingConfig type is introduced in tensorrt_llm.llmapi.llm_args with backend selection and optional configuration fields. Import statements across the torch pyexecutor module are updated to reference the new module location instead of tensorrt_llm.bindings.executor. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
![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 (1)
tensorrt_llm/llmapi/llm_args.py (1)
167-185: Add docstrings for the new public class and nested enum.The
GuidedDecodingConfigclass and its nestedGuidedDecodingBackendenum lack docstrings. Since this is a public API exposed in thellmapimodule, docstrings are recommended to document the purpose, usage, and parameters.As per coding guidelines
Consider adding Google-style docstrings:
class GuidedDecodingConfig(StrictBaseModel): + """ + Configuration for guided decoding. + + Attributes: + backend: The backend to use for guided decoding (XGRAMMAR or LLGUIDANCE). + encoded_vocab: Optional list of encoded vocabulary strings. + tokenizer_str: Optional tokenizer string representation. + stop_token_ids: Optional list of token IDs that indicate stopping. + """ class GuidedDecodingBackend(Enum): + """Backend options for guided decoding.""" XGRAMMAR = 0 LLGUIDANCE = 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
tensorrt_llm/_torch/pyexecutor/grammar_matcher.py(1 hunks)tensorrt_llm/_torch/pyexecutor/guided_decoder.py(1 hunks)tensorrt_llm/_torch/pyexecutor/py_executor_creator.py(1 hunks)tensorrt_llm/llmapi/llm_args.py(2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{h,hpp,hh,hxx,cpp,cxx,cc,cu,cuh,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
Use only spaces, no tabs; indent with 4 spaces.
Files:
tensorrt_llm/_torch/pyexecutor/py_executor_creator.pytensorrt_llm/llmapi/llm_args.pytensorrt_llm/_torch/pyexecutor/guided_decoder.pytensorrt_llm/_torch/pyexecutor/grammar_matcher.py
**/*.py
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
**/*.py: Python code must target Python 3.8+.
Indent Python code with 4 spaces; do not use tabs.
Maintain module namespace when importing; prefer 'from package.subpackage import foo' then 'foo.SomeClass()' instead of importing the class directly.
Python filenames should be snake_case (e.g., some_file.py).
Python classes use PascalCase names.
Functions and methods use snake_case names.
Local variables use snake_case; prefix 'k' for variables that start with a number (e.g., k_99th_percentile).
Global variables use upper SNAKE_CASE prefixed with 'G' (e.g., G_MY_GLOBAL).
Constants use upper SNAKE_CASE (e.g., MY_CONSTANT).
Avoid shadowing variables from an outer scope.
Initialize all externally visible members of a class in the constructor.
Prefer docstrings for interfaces that may be used outside a file; comments for in-function or file-local interfaces.
Use Google-style docstrings for classes and functions (Sphinx-parsable).
Document attributes and variables inline so they render under the class/function docstring.
Avoid reflection when a simpler, explicit approach suffices (e.g., avoid dict(**locals()) patterns).
In try/except, catch the most specific exceptions possible.
For duck-typing try/except, keep the try body minimal and use else for the main logic.
Files:
tensorrt_llm/_torch/pyexecutor/py_executor_creator.pytensorrt_llm/llmapi/llm_args.pytensorrt_llm/_torch/pyexecutor/guided_decoder.pytensorrt_llm/_torch/pyexecutor/grammar_matcher.py
**/*.{cpp,cxx,cc,h,hpp,hh,hxx,cu,cuh,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
Prepend the NVIDIA Apache-2.0 copyright header with current year to the top of all source files (e.g., .cpp, .h, .cu, .py).
Files:
tensorrt_llm/_torch/pyexecutor/py_executor_creator.pytensorrt_llm/llmapi/llm_args.pytensorrt_llm/_torch/pyexecutor/guided_decoder.pytensorrt_llm/_torch/pyexecutor/grammar_matcher.py
🧬 Code graph analysis (4)
tensorrt_llm/_torch/pyexecutor/py_executor_creator.py (1)
tensorrt_llm/llmapi/llm_args.py (3)
ContextChunkingPolicy(1069-1075)GuidedDecodingConfig(167-184)LoadFormat(2354-2359)
tensorrt_llm/llmapi/llm_args.py (1)
tensorrt_llm/builder.py (1)
default(48-56)
tensorrt_llm/_torch/pyexecutor/guided_decoder.py (2)
tensorrt_llm/llmapi/llm_args.py (1)
GuidedDecodingConfig(167-184)tensorrt_llm/sampling_params.py (1)
GuidedDecodingParams(15-37)
tensorrt_llm/_torch/pyexecutor/grammar_matcher.py (2)
tensorrt_llm/llmapi/llm_args.py (1)
GuidedDecodingConfig(167-184)tensorrt_llm/sampling_params.py (1)
GuidedDecodingParams(15-37)
🔇 Additional comments (3)
tensorrt_llm/_torch/pyexecutor/guided_decoder.py (1)
8-11: LGTM! Import path updated correctly.The import path for
GuidedDecodingConfighas been successfully updated fromtensorrt_llm.bindings.executortotensorrt_llm.llmapi.llm_args, aligning with the PR objective to use the Python-only configuration. The separation ofGuidedDecodingConfigandGuidedDecodingParamsimports is clean and appropriate.tensorrt_llm/_torch/pyexecutor/py_executor_creator.py (1)
17-20: LGTM! Import reorganization is clean.The import path for
GuidedDecodingConfighas been updated totensorrt_llm.llmapi.llm_argsand logically grouped with other configuration types (CapacitySchedulerPolicy,ContextChunkingPolicy,LoadFormat,TorchLlmArgs). The alphabetical ordering and grouping enhance readability.tensorrt_llm/_torch/pyexecutor/grammar_matcher.py (1)
9-11: LGTM! Import separation is appropriate.The import changes correctly separate
GuidedDecodingConfig(now fromtensorrt_llm.llmapi.llm_args) andGuidedDecodingParams(fromtensorrt_llm.bindings.executor). This separation is semantically correct: configuration types belong inllm_args, while runtime parameter types remain inbindings.executor.
…e in torch backend (NVIDIA#8717) Signed-off-by: leslie-fang25 <[email protected]>
3 participants
Summary by CodeRabbit
New Features
Refactor
Description
Define a python only
GuidedDecodingConfigand deprecatepybindbasedGuidedDecodingConfigusage with it in torch backendTest Coverage
PR Checklist
Please review the following before submitting your PR:
PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (see test instructions)
Any new dependencies have been scanned for license and vulnerabilities
CODEOWNERS updated if ownership changes
Documentation updated as needed
The reviewers assigned automatically/manually are appropriate for the PR.
Please check this after reviewing the above items as appropriate for this PR.
GitHub Bot Help
/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...Provide a user friendly way for developers to interact with a Jenkins server.
Run
/bot [-h|--help]to print this help message.See details below for each supported subcommand.
run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]Launch build/test pipelines. All previously running jobs will be killed.
--reuse-test (optional)pipeline-id(OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.--disable-reuse-test(OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.--disable-fail-fast(OPTIONAL) : Disable fail fast on build/tests/infra failures.--skip-test(OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.--stage-list "A10-PyTorch-1, xxx"(OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.--gpu-type "A30, H100_PCIe"(OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.--test-backend "pytorch, cpp"(OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.--only-multi-gpu-test(OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.--disable-multi-gpu-test(OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.--add-multi-gpu-test(OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.--post-merge(OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx"(OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".--detailed-log(OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.--debug(OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in thestage-listparameter to access the appropriate container environment. Note: Does NOT update GitHub check status.For guidance on mapping tests to stage names, see
docs/source/reference/ci-overview.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip testing for latest commit on pull request.
--comment "Reason for skipping build/test"is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.reuse-pipeline
reuse-pipelineReuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.