feat: allow model arguments to be registered outside

[njzjz]

Summary by CodeRabbit

• New Features

  • Introduced new plugins for handling model arguments, including standard, frozen, pairtab, pairwise_dprc, and linear_ener models.
  • Added support for hybrid models that require another model as input.

• Improvements

  • Enhanced argument-checking mechanisms to accommodate complex return types and nested structures.

[coderabbitai]

Walkthrough

Walkthrough

Significant updates were made to argcheck.py within the deepmd/utils directory. Key changes include the enhancement of function signatures in the ArgsPlugin class, the introduction of new decorators for model argument registration, and the addition of a new hybrid model arguments plugin to handle models requiring another model as input.

Changes

Files	Change Summary
deepmd/utils/argcheck.py	The register method in ArgsPlugin class now expects complex type hints involving nested Callable and Union types. Added new decorators for registering model arguments associated with specific types. Introduced hybrid_model_args_plugin.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant ArgsPlugin
    participant ModelRegistry

    Developer->>ArgsPlugin: Define new model argument decorators
    ArgsPlugin->>ModelRegistry: Register model argument plugins (e.g., "standard", "frozen")
    Developer->>ArgsPlugin: Introduce hybrid model arguments
    ArgsPlugin->>ModelRegistry: Register hybrid model argument plugins (e.g., "pairwise_dprc", "linear_ener")
    ModelRegistry->>Developer: Model arguments registered and ready for use

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Attention: Patch coverage is 92.85714% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.83%. Comparing base (6199b03) to head (f6db00d).
Report is 107 commits behind head on devel.

Files with missing lines	Patch %	Lines
deepmd/utils/argcheck.py	92.85%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            devel    #3995   +/-   ##
=======================================
  Coverage   82.83%   82.83%           
=======================================
  Files         522      522           
  Lines       50889    50901   +12     
  Branches     3015     3015           
=======================================
+ Hits        42154    42165   +11     
- Misses       7798     7799    +1     
  Partials      937      937           

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