Skip to content

Conversation

@njzjz
Copy link
Member

@njzjz njzjz commented May 20, 2025

Fix #4625.

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of modifier type decoding for more accurate output.
    • Corrected model type checking and output dictionary keys during evaluation.
    • Enhanced input sorting logic for atom types with multiple dimensions.
  • Tests
    • Updated test data and expected values to reflect recent changes.
    • Adjusted test logic to align with updated evaluation behavior.

Fix deepmodeling#4625.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 20, 2025

📝 Walkthrough

"""

Walkthrough

The updates refine the handling of model type checking, output key naming, and modifier type decoding in the TensorFlow inference module. Additionally, the test suite is updated to accommodate new expected values and an extra model file conversion, aligning with the internal changes in evaluation logic.

Changes

File(s) Change Summary
deepmd/tf/infer/deep_eval.py Decodes modifier_type from bytes, updates model type check to issubclass, corrects output dict keys, and adds dimensionality handling in atom type sorting.
source/tests/tf/test_dplr.py Converts an additional model file, updates expected energy/force values, and adjusts eval call to match new output handling.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Correct calculation and inclusion of data modifier (long-range correction) in DPLR model Python inference (#4625)

Possibly related PRs

Suggested reviewers

  • wanghan-iapcm
  • iProzd
    """

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 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 60fe66e and b99f80b.

📒 Files selected for processing (1)
  • source/tests/tf/test_dplr.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/tests/tf/test_dplr.py
✨ 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.
    • 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8176173 and 60fe66e.

📒 Files selected for processing (2)
  • deepmd/tf/infer/deep_eval.py (3 hunks)
  • source/tests/tf/test_dplr.py (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
source/tests/tf/test_dplr.py (1)
deepmd/tf/infer/deep_eval.py (1)
  • eval (695-777)
⏰ Context from checks skipped due to timeout of 90000ms (30)
  • 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: Build wheels for cp310-manylinux_aarch64
  • GitHub Check: Build wheels for cp311-win_amd64
  • GitHub Check: Test Python (4, 3.9)
  • GitHub Check: Build wheels for cp311-macosx_arm64
  • GitHub Check: Test Python (3, 3.12)
  • GitHub Check: Build C++ (clang, clang)
  • GitHub Check: Test Python (3, 3.9)
  • GitHub Check: Build wheels for cp311-macosx_x86_64
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
  • GitHub Check: Test Python (2, 3.12)
  • GitHub Check: Build C++ (rocm, rocm)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Test Python (2, 3.9)
  • GitHub Check: Build C++ (cuda120, cuda)
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
  • GitHub Check: Build C++ (cuda, cuda)
  • GitHub Check: Analyze (c-cpp)
  • GitHub Check: Test C++ (false)
  • GitHub Check: Test Python (1, 3.12)
  • GitHub Check: Test Python (1, 3.9)
  • GitHub Check: Test C++ (true)
  • GitHub Check: Build C library (2.14, >=2.5.0rc0,<2.15, libdeepmd_c_cu11.tar.gz)
  • GitHub Check: Build C++ (cpu, cpu)
  • GitHub Check: Build C library (2.18, libdeepmd_c.tar.gz)
🔇 Additional comments (3)
source/tests/tf/test_dplr.py (3)

24-27: Added conversion for lrdipole model

The test now converts an additional protobuf text file "lrdipole.pbtxt" to "lrdipole.pb", suggesting that the test requires this model file for some test cases, though it's not used in the current test method.

Would this model be used in future test methods or is there a missing test case that should use this model?


29-38: Updated expected energy and force values

The expected values for energy and forces have been updated to reflect changes in the computation logic in the main code. This ensures tests pass with the updated implementation.


58-58: Changed evaluation to use atomic=False

The call to dp.eval now explicitly sets atomic=False which aligns with the changes in the main implementation. This ensures we're not trying to extract atomic energies and virials when the modifier is active.

@njzjz
Copy link
Member Author

njzjz commented May 20, 2025

@ChiahsinChu Could you test whether you get the same result from this PR and v2?

@codecov
Copy link

codecov bot commented May 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.73%. Comparing base (8176173) to head (b99f80b).
⚠️ Report is 86 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4753      +/-   ##
==========================================
+ Coverage   84.70%   84.73%   +0.02%     
==========================================
  Files         697      697              
  Lines       67424    67425       +1     
  Branches     3541     3540       -1     
==========================================
+ Hits        57112    57132      +20     
+ Misses       9182     9161      -21     
- Partials     1130     1132       +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.

@ChiahsinChu
Copy link
Contributor

This PR should have fixed the bug. I got the same results from this one and v2.

@njzjz njzjz marked this pull request as ready for review May 21, 2025 03:14
@njzjz njzjz requested review from wanghan-iapcm and removed request for Yi-FanLi May 21, 2025 04:33
@njzjz njzjz added this to the v3.0.3 milestone May 21, 2025
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue May 21, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 21, 2025
@njzjz njzjz added this pull request to the merge queue May 21, 2025
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
@njzjz njzjz removed this pull request from the merge queue due to a manual request May 21, 2025
@njzjz njzjz enabled auto-merge May 21, 2025 09:22
@njzjz njzjz closed this May 21, 2025
auto-merge was automatically disabled May 21, 2025 09:22

Pull request was closed

@njzjz njzjz reopened this May 21, 2025
@njzjz njzjz enabled auto-merge May 21, 2025 09:22
@njzjz njzjz added this pull request to the merge queue May 21, 2025
Merged via the queue into deepmodeling:devel with commit 2fa4064 May 21, 2025
61 checks passed
@njzjz njzjz deleted the fix-4625 branch May 21, 2025 14:08
njzjz added a commit to njzjz/deepmd-kit that referenced this pull request May 21, 2025
Fix deepmodeling#4625.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
	- Improved handling of modifier type decoding for more accurate output.
- Corrected model type checking and output dictionary keys during
evaluation.
	- Enhanced input sorting logic for atom types with multiple dimensions.
- **Tests**
	- Updated test data and expected values to reflect recent changes.
	- Adjusted test logic to align with updated evaluation behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
(cherry picked from commit 2fa4064)
njzjz added a commit to njzjz/deepmd-kit that referenced this pull request May 21, 2025
Fix deepmodeling#4625.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
	- Improved handling of modifier type decoding for more accurate output.
- Corrected model type checking and output dictionary keys during
evaluation.
	- Enhanced input sorting logic for atom types with multiple dimensions.
- **Tests**
	- Updated test data and expected values to reflect recent changes.
	- Adjusted test logic to align with updated evaluation behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
(cherry picked from commit 2fa4064)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Incorrect results from DPLR model in python inference interface

3 participants