Skip to content

Conversation

@njzjz
Copy link
Member

@njzjz njzjz commented Jun 10, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved the stability and reliability of distance calculations during edge initialization, enhancing overall robustness.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
@njzjz njzjz requested review from Copilot and iProzd June 10, 2025 13:33
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR replaces the direct use of xp.linalg.vector_norm with a safer variant to avoid NaN outputs when edge_init_use_dist is enabled.

  • Swap xp.linalg.vector_norm for safe_for_vector_norm in the edge initialization path.
  • Ensures distance-based edge input computation handles zero or near-zero vectors without NaNs.
Comments suppressed due to low confidence (3)

deepmd/dpmodel/descriptor/repflows.py:529

  • Consider adding unit tests for the edge_init_use_dist path to verify that safe_for_vector_norm correctly handles cases which previously resulted in NaN values.
edge_input = safe_for_vector_norm(diff, axis=-1, keepdims=True)

deepmd/dpmodel/descriptor/repflows.py:528

  • [nitpick] Add a brief comment explaining why safe_for_vector_norm is used instead of xp.linalg.vector_norm to clarify the intention and avoid confusion.
if self.edge_init_use_dist:

deepmd/dpmodel/descriptor/repflows.py:529

  • It looks like safe_for_vector_norm is not imported in this module. Add the necessary import or ensure it's defined in this scope.
edge_input = safe_for_vector_norm(diff, axis=-1, keepdims=True)

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 10, 2025

📝 Walkthrough

Walkthrough

The update modifies the computation of vector norms in the DescrptBlockRepflows class by replacing a direct call to xp.linalg.vector_norm with safe_for_vector_norm for edge initialization when edge_init_use_dist is enabled. No other logic or function signatures are changed.

Changes

File(s) Change Summary
deepmd/dpmodel/descriptor/repflows.py Replaced xp.linalg.vector_norm with safe_for_vector_norm in edge norm calculation within DescrptBlockRepflows.call.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DescrptBlockRepflows
    participant safe_for_vector_norm

    User->>DescrptBlockRepflows: call(diff, edge_init_use_dist=True)
    DescrptBlockRepflows->>safe_for_vector_norm: compute norm(diff, axis=-1, keepdims=True)
    safe_for_vector_norm-->>DescrptBlockRepflows: return norm result
    DescrptBlockRepflows-->>User: continue with edge_input initialization
Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Pylint (3.3.7)
deepmd/dpmodel/descriptor/repflows.py

No files to lint: exiting.


📜 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 c46dc7d and 6bd237d.

📒 Files selected for processing (1)
  • deepmd/dpmodel/descriptor/repflows.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
deepmd/dpmodel/descriptor/repflows.py (1)
deepmd/dpmodel/utils/safe_gradient.py (1)
  • safe_for_vector_norm (18-32)
⏰ Context from checks skipped due to timeout of 90000ms (28)
  • GitHub Check: Build C library (2.18, libdeepmd_c.tar.gz)
  • GitHub Check: Build C library (2.14, >=2.5.0rc0,<2.15, libdeepmd_c_cu11.tar.gz)
  • GitHub Check: Build C++ (rocm, rocm)
  • GitHub Check: Build C++ (cuda, cuda)
  • GitHub Check: Build C++ (clang, clang)
  • GitHub Check: Build C++ (cuda120, cuda)
  • GitHub Check: Build C++ (cpu, cpu)
  • GitHub Check: Test Python (6, 3.9)
  • GitHub Check: Test Python (5, 3.12)
  • GitHub Check: Test Python (6, 3.12)
  • GitHub Check: Test Python (4, 3.12)
  • GitHub Check: Test Python (3, 3.9)
  • GitHub Check: Test Python (5, 3.9)
  • GitHub Check: Test Python (4, 3.9)
  • GitHub Check: Test Python (2, 3.9)
  • GitHub Check: Test Python (1, 3.12)
  • GitHub Check: Test Python (3, 3.12)
  • GitHub Check: Test Python (1, 3.9)
  • GitHub Check: Test Python (2, 3.12)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (c-cpp)
  • GitHub Check: Test C++ (true)
  • GitHub Check: Test C++ (false)
  • GitHub Check: Build wheels for cp310-manylinux_aarch64
  • GitHub Check: Build wheels for cp311-macosx_arm64
  • GitHub Check: Build wheels for cp311-macosx_x86_64
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
🔇 Additional comments (1)
deepmd/dpmodel/descriptor/repflows.py (1)

529-529: LGTM! Excellent fix for numerical stability.

This change appropriately replaces the direct vector norm computation with safe_for_vector_norm to prevent NaN gradients in JAX when diff contains zero vectors. The fix is consistent with the existing usage pattern on line 536 and directly addresses the NaN issue mentioned in the PR title.

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

@codecov
Copy link

codecov bot commented Jun 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.79%. Comparing base (c46dc7d) to head (6bd237d).
⚠️ Report is 85 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4794      +/-   ##
==========================================
- Coverage   84.79%   84.79%   -0.01%     
==========================================
  Files         698      698              
  Lines       67819    67819              
  Branches     3542     3541       -1     
==========================================
- Hits        57509    57506       -3     
  Misses       9178     9178              
- Partials     1132     1135       +3     

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

@njzjz njzjz enabled auto-merge June 10, 2025 18:27
@njzjz njzjz added this pull request to the merge queue Jun 10, 2025
Merged via the queue into deepmodeling:devel with commit a6042c6 Jun 11, 2025
90 of 96 checks passed
@njzjz njzjz deleted the fix-jax-dpa3-grad-nan branch June 11, 2025 02:54
ChiahsinChu pushed a commit to ChiahsinChu/deepmd-kit that referenced this pull request Dec 17, 2025
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved the stability and reliability of distance calculations during
edge initialization, enhancing overall robustness.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
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