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

Perf: print summary on rank 0 #4434

Merged
merged 1 commit into from
Nov 27, 2024
Merged

Conversation

caic99
Copy link
Member

@caic99 caic99 commented Nov 27, 2024

Summary by CodeRabbit

  • Bug Fixes
    • Adjusted the summary printing functionality to ensure it only executes from the main process in distributed settings, preventing duplicate outputs.

Copy link
Contributor

coderabbitai bot commented Nov 27, 2024

📝 Walkthrough

Walkthrough

The changes involve a modification to the print_summary method in the DpLoaderSet class located in deepmd/pt/utils/dataloader.py. A rank check using dist.get_rank() has been added to ensure that only the main process (rank 0) executes the print_summary function in a distributed environment. This prevents multiple processes from printing simultaneously, while the rest of the method's functionality remains unchanged.

Changes

File Change Summary
deepmd/pt/utils/dataloader.py Modified print_summary method in DpLoaderSet to include a rank check using dist.get_rank().

Sequence Diagram(s)

sequenceDiagram
    participant MainProcess as Main Process (rank 0)
    participant OtherProcesses as Other Processes (rank > 0)
    
    MainProcess->>+MainProcess: Execute print_summary()
    MainProcess-->>-MainProcess: Print summary
    
    OtherProcesses->>+OtherProcesses: Attempt to execute print_summary()
    OtherProcesses-->>-OtherProcesses: Skip printing
Loading

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 (1)
deepmd/pt/utils/dataloader.py (1)

188-202: LGTM! Clean implementation of rank-based printing.

The changes correctly ensure that summary printing only occurs on the main process (rank 0) in distributed settings, while maintaining the original functionality in non-distributed mode. This will help reduce log clutter in distributed training.

Consider adding debug logging for non-rank-0 processes to maintain logging consistency:

         rank = dist.get_rank() if dist.is_initialized() else 0
         if rank == 0:
             print_summary(
                 name,
                 len(self.systems),
                 [ss.system for ss in self.systems],
                 [ss._natoms for ss in self.systems],
                 self.batch_sizes,
                 [
                     ss._data_system.get_sys_numb_batch(self.batch_sizes[ii])
                     for ii, ss in enumerate(self.systems)
                 ],
                 prob,
                 [ss._data_system.pbc for ss in self.systems],
             )
+        else:
+            log.debug(f"Skipping print_summary on rank {rank}")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f343a3b and dcb1841.

📒 Files selected for processing (1)
  • deepmd/pt/utils/dataloader.py (1 hunks)

Copy link

codecov bot commented Nov 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.64%. Comparing base (f343a3b) to head (dcb1841).
Report is 3 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4434   +/-   ##
=======================================
  Coverage   84.64%   84.64%           
=======================================
  Files         614      614           
  Lines       57138    57138           
  Branches     3487     3486    -1     
=======================================
  Hits        48367    48367           
+ Misses       7646     7644    -2     
- Partials     1125     1127    +2     

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

@njzjz njzjz added this pull request to the merge queue Nov 27, 2024
Merged via the queue into deepmodeling:devel with commit 4b92b6d Nov 27, 2024
60 checks passed
@caic99 caic99 deleted the perf-summary branch November 28, 2024 02:08
@njzjz njzjz added this to the v3.0.1 milestone Dec 6, 2024
njzjz pushed a commit to njzjz/deepmd-kit that referenced this pull request Dec 22, 2024
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Adjusted the summary printing functionality to ensure it only executes
from the main process in distributed settings, preventing duplicate
outputs.

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

(cherry picked from commit 4b92b6d)
njzjz pushed a commit that referenced this pull request Dec 23, 2024
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Adjusted the summary printing functionality to ensure it only executes
from the main process in distributed settings, preventing duplicate
outputs.

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

(cherry picked from commit 4b92b6d)
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