Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bug: fix numerical diff in DPA1 dotr between DP/PT #3725

Merged
merged 1 commit into from
Apr 30, 2024

Conversation

iProzd
Copy link
Collaborator

@iProzd iProzd commented Apr 30, 2024

Summary by CodeRabbit

  • Bug Fixes
    • Improved stability in calculations by handling potential division by zero errors.

Copy link
Contributor

coderabbitai bot commented Apr 30, 2024

Walkthrough

Walkthrough

The update involves a modification in the call method within the dpa1.py file, specifically enhancing the stability of a division operation. This is achieved by incorporating the np.maximum function to prevent division by zero or extremely small numbers during the normalization process of a matrix.

Changes

File Path Change Summary
.../descriptor/dpa1.py Added np.maximum in the calculation of input_r to ensure stability in division by avoiding small denominators.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 49f17cc and 3a34c56.
Files selected for processing (1)
  • deepmd/dpmodel/descriptor/dpa1.py (1 hunks)
Additional comments not posted (1)
deepmd/dpmodel/descriptor/dpa1.py (1)

508-512: The modification to input_r calculation enhances numerical stability by preventing division by near-zero values.

Verification successful

The changes to the input_r calculation in the DescrptDPA1 class have been successfully verified. The new method using np.maximum is correctly implemented in dpa1.py, and the old division method has been completely replaced across the codebase. The module is actively used in several test files, ensuring that the changes are integrated and tested.

  • source/tests/pt/model/test_dpa1.py
  • source/tests/consistent/descriptor/test_dpa1.py
  • source/tests/common/dpmodel/test_descriptor_hybrid.py
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Test: Search to find files that import dpa1 module. Expect: Matches.
rg -C3 --type python $'from deepmd.dpmodel.descriptor.dpa1'
# Test: Search old division method to find omissions. Expect: No matches.
ast-grep --lang python --pattern $'dmatrix.reshape(-1, nnei, 4)[:, :, 1:4] / np.linalg.norm(dmatrix.reshape(-1, nnei, 4)[:, :, 1:4], axis=-1, keepdims=True)'
# Test: Search new division method to validate usage. Expect: Matches.
ast-grep --lang python --pattern $'dmatrix.reshape(-1, nnei, 4)[:, :, 1:4] / np.maximum(np.linalg.norm(dmatrix.reshape(-1, nnei, 4)[:, :, 1:4], axis=-1, keepdims=True), 1e-12)'

Length of output: 892



Script:

#!/bin/bash
# Correct file type error and search for files that import the dpa1 module. Expect: Matches.
rg -C3 --type py 'from deepmd.dpmodel.descriptor.dpa1'
# Re-run the search for the old division method to ensure it has been completely replaced. Expect: No matches.
ast-grep --lang python --pattern $'dmatrix.reshape(-1, nnei, 4)[:, :, 1:4] / np.linalg.norm(dmatrix.reshape(-1, nnei, 4)[:, :, 1:4], axis=-1, keepdims=True)'

Length of output: 1629


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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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.

@iProzd iProzd requested a review from njzjz April 30, 2024 05:33
Copy link
Member

@njzjz njzjz left a comment

Choose a reason for hiding this comment

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

I confirm it works!

Copy link

codecov bot commented Apr 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.15%. Comparing base (49f17cc) to head (3a34c56).

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3725   +/-   ##
=======================================
  Coverage   82.15%   82.15%           
=======================================
  Files         511      511           
  Lines       47364    47364           
  Branches     2953     2955    +2     
=======================================
  Hits        38910    38910           
  Misses       7561     7561           
  Partials      893      893           

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

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Apr 30, 2024
Merged via the queue into deepmodeling:devel with commit b5f7634 Apr 30, 2024
60 checks passed
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved stability in calculations by handling potential division by
zero errors.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants