Chore(pt): add `--model-branch` as alias #4730

iProzd · 2025-05-09T04:34:29Z

Summary by CodeRabbit

New Features
- Added a new command-line option alias, --model-branch, for the --head argument in the "freeze" and "test" subcommands. Both options can now be used interchangeably.
Tests
- Updated tests to use the new --model-branch argument in command-line examples, ensuring compatibility with the updated interface.

coderabbitai · 2025-05-09T04:36:13Z

📝 Walkthrough

Walkthrough

The command-line interface in deepmd/main.py was updated to add --model-branch as an alias for the --head argument in the "freeze" and "test" subcommands. Corresponding test cases in both TensorFlow and PyTorch test suites were updated to use the new --model-branch option instead of --head.

Changes

File(s)	Change Summary
deepmd/main.py	Updated CLI argument parser for "freeze" and "test" subcommands to add `--model-branch` as an alias for `--head`. Help text was updated accordingly. No other logic was changed.
source/tests/pd/test_dp_show.py source/tests/pt/test_dp_show.py	Updated test commands in `TestMultiTaskModel` to use `--model-branch` instead of `--head` for the "freeze" subcommand. No other changes made.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI (deepmd/main.py)
    participant Freeze/Test Logic

    User->>CLI (deepmd/main.py): Run "dp ... freeze --model-branch model_1"
    CLI (deepmd/main.py)->>Freeze/Test Logic: Parse --model-branch (alias for --head)
    Freeze/Test Logic-->>CLI (deepmd/main.py): Execute freeze/test with selected model branch
    CLI (deepmd/main.py)-->>User: Output results

📜 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 17da9d2 and a760302.

📒 Files selected for processing (3)

deepmd/main.py (2 hunks)
source/tests/pd/test_dp_show.py (1 hunks)
source/tests/pt/test_dp_show.py (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

source/tests/pt/test_dp_show.py (1)

source/tests/pt/common.py (1)

run_dp (27-49)

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

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

🔇 Additional comments (4)

deepmd/main.py (2)

332-337: Good improvement to CLI by adding more descriptive alias.

Adding --model-branch as an alias for --head makes the CLI more intuitive and descriptive for users working with multi-task models. The updated help text clearly explains the relationship between the two options.

412-417: Consistent application of the alias across commands.

The alias has been correctly added to the "test" subcommand as well, maintaining consistency across the CLI. The help text mirrors the update in the "freeze" command, which is good practice.

source/tests/pt/test_dp_show.py (1)

143-143: Test updated to use new CLI option.

The test has been properly updated to use the --model-branch option instead of --head, ensuring that the new alias is covered by the test suite.

source/tests/pd/test_dp_show.py (1)

151-151: Test updated consistently for Paddle backend.

The test for the Paddle backend has been updated in the same way as the PyTorch version, ensuring consistent testing across backends.

✨ Finishing Touches

📝 Generate Docstrings

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

🪧 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.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate unit testing code.
- @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 · 2025-05-09T05:24:25Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.81%. Comparing base (17da9d2) to head (a760302).
⚠️ Report is 77 commits behind head on devel.

Additional details and impacted files

@@           Coverage Diff           @@
##            devel    #4730   +/-   ##
=======================================
  Coverage   84.80%   84.81%           
=======================================
  Files         696      696           
  Lines       67269    67268    -1     
  Branches     3541     3540    -1     
=======================================
  Hits        57050    57050           
+ Misses       9087     9086    -1     
  Partials     1132     1132

☔ 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.

Chore(pt): add --model-branch as alias

d82100c

github-actions bot added the Python label May 9, 2025

update test

a760302

iProzd requested review from njzjz and wanghan-iapcm May 9, 2025 08:26

wanghan-iapcm approved these changes May 9, 2025

View reviewed changes

njzjz approved these changes May 9, 2025

View reviewed changes

njzjz added this pull request to the merge queue May 10, 2025

Merged via the queue into deepmodeling:devel with commit cc44b86 May 10, 2025
60 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Chore(pt): add `--model-branch` as alias #4730

Chore(pt): add `--model-branch` as alias #4730

Uh oh!

iProzd commented May 9, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 9, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented May 9, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Chore(pt): add --model-branch as alias #4730

Chore(pt): add --model-branch as alias #4730

Uh oh!

Conversation

iProzd commented May 9, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Chore(pt): add `--model-branch` as alias #4730

Chore(pt): add `--model-branch` as alias #4730

iProzd commented May 9, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 9, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented May 9, 2025 •

edited

Loading