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

fix(pt): fix zero inputs for LayerNorm #4134

Merged
merged 1 commit into from
Sep 18, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Sep 17, 2024

Fix #4064.

Summary by CodeRabbit

  • Bug Fixes
    • Improved robustness of layer normalization by handling empty input tensors, ensuring consistent output without errors.

Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Walkthrough

Walkthrough

The modification enhances the layer normalization implementation by adding a conditional check in the forward method. It verifies if the input tensor is non-empty before computing the mean and variance. If the tensor is empty, it bypasses normalization, ensuring that the output matches the input. This change prevents potential errors related to empty tensors during normalization.

Changes

Files Change Summary
deepmd/pt/model/network/layernorm.py Added a check for non-empty input tensor in the forward method to prevent errors during normalization.

Assessment against linked issues

Objective Addressed Explanation
UserWarning: var_mean(): degrees of freedom is <= 0 (Issue #4064)

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0c59ef3 and e15b97b.

Files selected for processing (1)
  • deepmd/pt/model/network/layernorm.py (1 hunks)
Additional comments not posted (1)
deepmd/pt/model/network/layernorm.py (1)

99-103: Robust handling of empty input tensors in LayerNorm.

The introduction of the conditional check if xx.numel() > 0 enhances the robustness of the layer normalization by gracefully handling the case of empty input tensors. When xx is non-empty, the code computes the variance and mean using torch.var_mean and normalizes xx accordingly. This approach is more reliable compared to using xx.mean and xx.var separately, as it avoids potential errors when using jit models for inference.

If xx is empty, the code directly assigns yy to xx, effectively bypassing the normalization step. This ensures that the output remains consistent with the input in such cases, preventing potential errors that could occur during normalization.

Overall, these changes align with the issue description and provide a robust solution to handle zero inputs in the LayerNorm function.


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

Copy link

codecov bot commented Sep 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.02%. Comparing base (96ed5df) to head (e15b97b).
Report is 6 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4134   +/-   ##
=======================================
  Coverage   83.02%   83.02%           
=======================================
  Files         532      532           
  Lines       52187    52189    +2     
  Branches     3030     3030           
=======================================
+ Hits        43330    43332    +2     
- Misses       7911     7912    +1     
+ Partials      946      945    -1     

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

@iProzd iProzd added this pull request to the merge queue Sep 18, 2024
Merged via the queue into deepmodeling:devel with commit ba9f02f Sep 18, 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
3 participants