docs: fix PyTorch compression command

[njzjz]

Summary by CodeRabbit

• Documentation
  • Updated the command example for compressing a PyTorch model to explicitly include the --pt flag.

[Copilot]

Pull Request Overview

This PR updates the PyTorch compression command in the documentation to correctly reflect the required command-line flag.

• Updated the command from "dp compress -i model.pth -o model-compress.pth" to "dp --pt compress -i model.pth -o model-compress.pth" to fix the usage for PyTorch.

[coderabbitai]

📝 Walkthrough

Walkthrough

The documentation for compressing a PyTorch model was updated to include the --pt flag in the example command, clarifying the explicit selection of the PyTorch backend when using the dp compress command.

Changes

File(s)	Change Summary
doc/freeze/compress.md	Updated example command to add --pt flag for PyTorch.

Possibly related PRs

• Add pt compression doc #4299: Refined the PyTorch compression documentation by initially introducing the PyTorch-specific compress command example.

Suggested labels

Docs

Suggested reviewers

• wanghan-iapcm

---

📜 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 265d094 and bd158fc.

📒 Files selected for processing (1)

• doc/freeze/compress.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (29)

• GitHub Check: Test Python (6, 3.9)
• GitHub Check: Test Python (4, 3.9)
• GitHub Check: Test Python (4, 3.12)
• GitHub Check: Test Python (6, 3.12)
• GitHub Check: Test Python (5, 3.12)
• GitHub Check: Test Python (5, 3.9)
• GitHub Check: Test Python (3, 3.12)
• GitHub Check: Test Python (3, 3.9)
• GitHub Check: Test Python (2, 3.9)
• GitHub Check: Test Python (1, 3.9)
• GitHub Check: Test Python (2, 3.12)
• GitHub Check: Test Python (1, 3.12)
• GitHub Check: Analyze (c-cpp)
• GitHub Check: Analyze (python)
• GitHub Check: Build C++ (clang, clang)
• GitHub Check: Build C++ (cpu, cpu)
• GitHub Check: Build C++ (cuda, cuda)
• GitHub Check: Build C++ (cuda120, cuda)
• GitHub Check: Build C++ (rocm, rocm)
• GitHub Check: Build C library (2.18, libdeepmd_c.tar.gz)
• GitHub Check: Build C library (2.14, >=2.5.0rc0,<2.15, libdeepmd_c_cu11.tar.gz)
• GitHub Check: Build wheels for cp311-macosx_arm64
• GitHub Check: Test C++ (false)
• GitHub Check: Test C++ (true)
• GitHub Check: Build wheels for cp310-manylinux_aarch64
• GitHub Check: Build wheels for cp311-win_amd64
• GitHub Check: Build wheels for cp311-macosx_x86_64
• GitHub Check: Build wheels for cp311-manylinux_x86_64
• GitHub Check: Build wheels for cp311-manylinux_x86_64

🔇 Additional comments (1)

doc/freeze/compress.md (1)

80-80: Explicitly specify the PyTorch backend with --pt
Great catch—adding the --pt flag makes the example unambiguous by selecting the PyTorch backend when running dp compress.

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.79%. Comparing base (265d094) to head (bd158fc).
⚠️ Report is 82 commits behind head on devel.

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #4780      +/-   ##
==========================================
- Coverage   84.79%   84.79%   -0.01%     
==========================================
  Files         698      698              
  Lines       67775    67775              
  Branches     3544     3542       -2     
==========================================
- Hits        57472    57470       -2     
  Misses       9169     9169              
- Partials     1134     1136       +2     

☔ 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.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.