[None][doc] Update Enc_Dec README.md #6636
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update the readme to fix an issue requiring git-lfs to download the model instead of git Signed-off-by: esnvidia <[email protected]>
📝 WalkthroughWalkthroughThe documentation for downloading model weights in the encoder-decoder models example was updated. The section title now specifies the use of Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
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 (1)
✅ Files skipped from review due to trivial changes (1)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
@laikhtewari for review. |
![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
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
examples/models/core/enc_dec/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: in tensorrt-llm, examples directory can have different dependency versions than the root requirement...
Learnt from: yibinl-nvidia
PR: NVIDIA/TensorRT-LLM#6506
File: examples/models/core/mixtral/requirements.txt:3-3
Timestamp: 2025-08-01T15:14:45.673Z
Learning: In TensorRT-LLM, examples directory can have different dependency versions than the root requirements.txt file. Version conflicts between root and examples dependencies are acceptable because examples are designed to be standalone and self-contained.
Applied to files:
examples/models/core/enc_dec/README.md
📚 Learning: in tensorrt-llm testing, it's common to have both cli flow tests (test_cli_flow.py) and pytorch api ...
Learnt from: moraxu
PR: NVIDIA/TensorRT-LLM#6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.
Applied to files:
examples/models/core/enc_dec/README.md
Comment on lines
56
to
64
| ### Download weights from HuggingFace Transformers using `git-lfs` | ||
|
|
||
| ```bash | ||
| git clone https://huggingface.co/t5-small tmp/hf_models/t5-small | ||
| git clone https://huggingface.co/google/flan-t5-small tmp/hf_models/flan-t5-small | ||
| git clone https://huggingface.co/facebook/bart-large-cnn tmp/hf_models/bart-large-cnn | ||
| git clone https://huggingface.co/facebook/mbart-large-50-many-to-one-mmt tmp/hf_models/mbart-large-50-many-to-one-mmt | ||
| git clone https://huggingface.co/google/byt5-small tmp/hf_models/byt5-small | ||
| git-lfs clone https://huggingface.co/t5-small tmp/hf_models/t5-small | ||
| git-lfs clone https://huggingface.co/google/flan-t5-small tmp/hf_models/flan-t5-small | ||
| git-lfs clone https://huggingface.co/facebook/bart-large-cnn tmp/hf_models/bart-large-cnn | ||
| git-lfs clone https://huggingface.co/facebook/mbart-large-50-many-to-one-mmt tmp/hf_models/mbart-large-50-many-to-one-mmt | ||
| git-lfs clone https://huggingface.co/google/byt5-small tmp/hf_models/byt5-small | ||
| ``` |
There was a problem hiding this comment.
Incorrect Git-LFS command; replace git-lfs with git lfs and document the install step
The CLI shipped with Git LFS is invoked as a Git sub-command (git lfs …).
git-lfs clone is not guaranteed to exist on all platforms and will fail on a stock installation, so the copy-&-paste commands below are likely to break for users.
-### Download weights from HuggingFace Transformers using `git-lfs`
+### Download weights from HuggingFace Transformers using Git LFS-git-lfs clone https://huggingface.co/t5-small tmp/hf_models/t5-small
-git-lfs clone https://huggingface.co/google/flan-t5-small tmp/hf_models/flan-t5-small
-git-lfs clone https://huggingface.co/facebook/bart-large-cnn tmp/hf_models/bart-large-cnn
-git-lfs clone https://huggingface.co/facebook/mbart-large-50-many-to-one-mmt tmp/hf_models/mbart-large-50-many-to-one-mmt
-git-lfs clone https://huggingface.co/google/byt5-small tmp/hf_models/byt5-small
+git lfs install # one-time setup
+git lfs clone https://huggingface.co/t5-small tmp/hf_models/t5-small
+git lfs clone https://huggingface.co/google/flan-t5-small tmp/hf_models/flan-t5-small
+git lfs clone https://huggingface.co/facebook/bart-large-cnn tmp/hf_models/bart-large-cnn
+git lfs clone https://huggingface.co/facebook/mbart-large-50-many-to-one-mmt tmp/hf_models/mbart-large-50-many-to-one-mmt
+git lfs clone https://huggingface.co/google/byt5-small tmp/hf_models/byt5-smallThis change prevents installation-time friction and aligns with the official Git LFS documentation.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ### Download weights from HuggingFace Transformers using `git-lfs` | |
| ```bash | |
| git clone https://huggingface.co/t5-small tmp/hf_models/t5-small | |
| git clone https://huggingface.co/google/flan-t5-small tmp/hf_models/flan-t5-small | |
| git clone https://huggingface.co/facebook/bart-large-cnn tmp/hf_models/bart-large-cnn | |
| git clone https://huggingface.co/facebook/mbart-large-50-many-to-one-mmt tmp/hf_models/mbart-large-50-many-to-one-mmt | |
| git clone https://huggingface.co/google/byt5-small tmp/hf_models/byt5-small | |
| git-lfs clone https://huggingface.co/t5-small tmp/hf_models/t5-small | |
| git-lfs clone https://huggingface.co/google/flan-t5-small tmp/hf_models/flan-t5-small | |
| git-lfs clone https://huggingface.co/facebook/bart-large-cnn tmp/hf_models/bart-large-cnn | |
| git-lfs clone https://huggingface.co/facebook/mbart-large-50-many-to-one-mmt tmp/hf_models/mbart-large-50-many-to-one-mmt | |
| git-lfs clone https://huggingface.co/google/byt5-small tmp/hf_models/byt5-small | |
| ``` | |
| ### Download weights from HuggingFace Transformers using Git LFS | |
🤖 Prompt for AI Agents
In examples/models/core/enc_dec/README.md around lines 56 to 64, the commands
use the incorrect `git-lfs` syntax which may not work on all platforms. Replace
all instances of `git-lfs clone` with `git lfs clone` to use the correct Git
sub-command syntax. Additionally, add a note or instruction on installing Git
LFS before these commands to ensure users have it set up properly.
replace `git-lfs` with `git lfs` Signed-off-by: esnvidia <[email protected]>
nv-guomingz
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the readme to fix an issue requiring git-lfs to download the model instead of git
Summary by CodeRabbit
git-lfsand revised example commands accordingly.Description
Test Coverage
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.