feat: DeepEval.get_model_def_script and common dp show

[njzjz]

Fix #4019.

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a show command to display model attributes via the command line.
  • Added a method to retrieve the model definition script for enhanced model access and usability.
  • Enhanced model configuration options in YAML files, allowing for detailed specifications of architecture and training parameters.

• Bug Fixes

  • Simplified help messages for the show command, improving user clarity.

• Tests

  • Added new tests to validate the retrieval of model definition scripts, ensuring accuracy in model configurations.

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce a new method get_model_def_script across multiple files, enhancing the ability to retrieve model definitions in a structured format. A new command show is added to the main entry point, allowing users to access model attributes directly. Additionally, configuration files are updated to include model definition scripts, and corresponding tests are added to validate these functionalities.

Changes

Files	Change Summary
deepmd/dpmodel/infer/deep_eval.py	Added get_model_def_script method to retrieve model definitions.
deepmd/entrypoints/main.py	Introduced show command to the CLI.
deepmd/entrypoints/show.py	Added show function to display model attributes.
deepmd/infer/deep_eval.py	Added get_model_def_script method in both base and derived classes.
deepmd/main.py	Modified main function to accept optional command-line arguments and updated help message for show command.
deepmd/pt/entrypoints/main.py	Removed show function that displayed model attributes.
deepmd/pt/infer/deep_eval.py	Modified head parameter type and added get_model_def_script method.
deepmd/tf/infer/deep_eval.py	Added get_model_def_script method to retrieve model definitions from a tensor.
source/tests/infer/case.py	Introduced model_def_script attribute in class constructor.
source/tests/infer/deeppot-testcase.yaml	Added model_def_script configuration section for model specifications.
source/tests/infer/fparam_aparam-testcase.yaml	Added model_def_script configuration section for model specifications.
source/tests/infer/test_models.py	Added test_model_script_def to validate the model definition script retrieval.
source/tests/pt/common.py	Changed import path for main function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant ShowFunction
    participant DeepEval

    User->>CLI: Invoke `dp show`
    CLI->>ShowFunction: Call show(INPUT, ATTRIBUTES)
    ShowFunction->>DeepEval: Initialize DeepEval with INPUT
    DeepEval->>DeepEval: Check if multitask
    DeepEval->>ShowFunction: Log multitask status
    ShowFunction->>DeepEval: Retrieve attributes
    ShowFunction->>User: Display attributes

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Support dp show for TF models (4019)	✅

Possibly related PRs

• test(pt): add common test case for model/atomic model #3767: Introduces get_ntypes in the CM class, related to model definitions.
• chore: improve type anotations in deepmd.infer #3792: Modifications in deep_eval.py may interact with get_model_def_script.
• feat(pt): consistent fine-tuning with init-model #3803: Enhancements in user interaction with the new show command.
• feat(pt): support eval_typeebd for DeepEval #4110: Addition of eval_typeebd in DeepEval, enhancing evaluation capabilities.

Suggested labels

Docs

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f5b1b69 and ea6e4e8.

Files selected for processing (1)

• deepmd/pt/infer/deep_eval.py (5 hunks)

Files skipped from review as they are similar to previous changes (1)

• deepmd/pt/infer/deep_eval.py

Warning

Review ran into problems

Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review.

---

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>, 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 generate interesting stats about this repository and render them as a table.
  -- @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 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 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

Attention: Patch coverage is 97.01493% with 2 lines in your changes missing coverage. Please review.

Project coverage is 83.09%. Comparing base (96ed5df) to head (ea6e4e8).
Report is 5 commits behind head on devel.

Files with missing lines	Patch %	Lines
deepmd/dpmodel/infer/deep_eval.py	66.66%	1 Missing ⚠️
deepmd/infer/deep_eval.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #4131      +/-   ##
==========================================
+ Coverage   83.02%   83.09%   +0.06%     
==========================================
  Files         532      533       +1     
  Lines       52187    52208      +21     
  Branches     3030     3030              
==========================================
+ Hits        43330    43383      +53     
+ Misses       7911     7880      -31     
+ Partials      946      945       -1     

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