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

Chore: remove grad from nlist linear model #4380

Merged

Conversation

anyangml
Copy link
Collaborator

@anyangml anyangml commented Nov 19, 2024

Summary by CodeRabbit

  • New Features

    • Improved gradient tracking capabilities during model forward passes.
    • Enhanced weight computation for atomic models, allowing for better handling of neighbor list sizes and transitions.
  • Bug Fixes

    • Resolved issues with weight calculations based on atom distances.
    • Added error handling to ensure proper boundaries in weight computations.

@anyangml anyangml requested a review from njzjz November 19, 2024 07:21
Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the LinearEnergyAtomicModel and DPZBLLinearEnergyAtomicModel classes within the deepmd/pt/model/atomic_model/linear_atomic_model.py file. Key updates include adjustments to the forward_atomic method for improved gradient tracking through tensor detachment and enhancements to the _compute_weight method for a more complex weight calculation based on atom distances and neighbor list conditions.

Changes

File Path Change Summary
deepmd/pt/model/atomic_model/linear_atomic_model.py - Updated forward_atomic method in LinearEnergyAtomicModel to detach tensor for gradient tracking.
- Enhanced _compute_weight method in DPZBLLinearEnergyAtomicModel for improved weight computation based on atom distances and neighbor list conditions, including error handling for boundary assertions.

Possibly related PRs

  • Feat: Add consistency test for ZBL between dp and pt  #4292: The changes in the main PR involve the DPZBLLinearEnergyAtomicModel, which is directly related to the DPZBLModel introduced in this retrieved PR, as both models are part of the same atomic model framework and involve similar functionalities.

Suggested reviewers

  • njzjz

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 63d8c28 and a66bced.

📒 Files selected for processing (1)
  • deepmd/pt/model/atomic_model/linear_atomic_model.py (1 hunks)
🔇 Additional comments (1)
deepmd/pt/model/atomic_model/linear_atomic_model.py (1)

256-259: ⚠️ Potential issue

Potential Issue with Detaching extended_coord Affecting Gradient Flow

The extended_coord tensor is detached before passing it to build_multiple_neighbor_list:

extended_coord.detach(),

Detaching extended_coord stops gradient tracking, which means gradients will not flow back through extended_coord during neighbor list construction. If gradient information from extended_coord is needed later for backpropagation, this could prevent proper training of the model.

Recommendation:

  • If intentional: Ensure that detaching is necessary and that stopping the gradient here does not affect the model's learning capability.
  • If unintentional: Remove the detach() to maintain gradient flow through extended_coord.

Consider verifying whether gradient tracking through extended_coord is required for your application.


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

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.

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: 0

🧹 Outside diff range and nitpick comments (3)
deepmd/pt/model/atomic_model/linear_atomic_model.py (3)

259-260: LGTM! Optimized gradient tracking

The conditional gradient tracking is a good optimization that ensures gradients are only computed when needed through do_grad_r() or do_grad_c().

Consider adding a debug log to track when gradients are enabled, which could help with performance analysis:

 if self.do_grad_r() or self.do_grad_c():
+    logger.debug("Enabling gradients for extended_coord")
     extended_coord.requires_grad_(True)

Line range hint 673-674: Consider increasing the clamp threshold for better numerical stability

The current clamp threshold of 1e-20 for preventing division by zero might be too small for float64 precision.

-denominator = torch.sum(
+denominator = torch.clamp(torch.sum(
     torch.where(
         nlist_larger != -1,
         torch.exp(-pairwise_rr / self.smin_alpha),
         torch.zeros_like(nlist_larger),
     ),
     dim=-1,
- )  # handle masked nnei.
+), min=1e-16)  # increased threshold for better numerical stability

Line range hint 675-686: Optimize tensor operations for better performance

The current implementation creates multiple intermediate tensors. Consider combining operations to reduce memory allocations.

-u = (sigma - self.sw_rmin) / (self.sw_rmax - self.sw_rmin)
-coef = torch.zeros_like(u)
-left_mask = sigma < self.sw_rmin
-mid_mask = (self.sw_rmin <= sigma) & (sigma < self.sw_rmax)
-right_mask = sigma >= self.sw_rmax
-coef[left_mask] = 1
-smooth = -6 * u**5 + 15 * u**4 - 10 * u**3 + 1
-coef[mid_mask] = smooth[mid_mask]
-coef[right_mask] = 0

+# Compute normalized distance once
+u = torch.clamp((sigma - self.sw_rmin) / (self.sw_rmax - self.sw_rmin), 0.0, 1.0)
+# Compute smooth transition directly
+coef = torch.where(sigma < self.sw_rmin, 
+                  torch.ones_like(sigma),
+                  torch.where(sigma >= self.sw_rmax,
+                            torch.zeros_like(sigma),
+                            -6 * u**5 + 15 * u**4 - 10 * u**3 + 1))
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f879b48 and 63d8c28.

📒 Files selected for processing (1)
  • deepmd/pt/model/atomic_model/linear_atomic_model.py (1 hunks)

@njzjz njzjz enabled auto-merge November 19, 2024 07:43
@njzjz njzjz disabled auto-merge November 19, 2024 09:11
Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.50%. Comparing base (0ad4289) to head (a66bced).
Report is 9 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff            @@
##            devel    #4380    +/-   ##
========================================
  Coverage   84.50%   84.50%            
========================================
  Files         596      604     +8     
  Lines       56665    56942   +277     
  Branches     3459     3486    +27     
========================================
+ Hits        47884    48120   +236     
- Misses       7654     7697    +43     
+ Partials     1127     1125     -2     

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


🚨 Try these New Features:

@njzjz njzjz added this pull request to the merge queue Nov 19, 2024
Merged via the queue into deepmodeling:devel with commit 6039e0b Nov 19, 2024
60 checks passed
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.

2 participants