Skip to content

fix(pt): set device for PT C++ #4261

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

Merged
merged 3 commits into from
Oct 28, 2024
Merged

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Oct 26, 2024

Fix #4171.

Summary by CodeRabbit

  • New Features

    • Improved GPU initialization to ensure the correct device is utilized.
    • Enhanced error handling for clearer context on exceptions.
  • Bug Fixes

    • Updated error handling in multiple methods to catch and rethrow specific exceptions.
    • Added logic to handle communication-related tensors during computation.

@njzjz njzjz linked an issue Oct 26, 2024 that may be closed by this pull request
@github-actions github-actions bot added the C++ label Oct 26, 2024
Copy link
Contributor

coderabbitai bot commented Oct 26, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes made to the DeepPotPT class in DeepPotPT.cc include the addition of GPU device selection in the init method and enhancements to error handling in the translate_error method. The modifications ensure that the correct GPU is utilized during initialization and improve the robustness of exception handling by catching multiple error types. The computew methods were updated to maintain these improvements, while the createNlistTensor function remains unchanged.

Changes

File Change Summary
source/api_cc/src/DeepPotPT.cc - Added DPErrcheck(DPSetDevice(gpu_id)); in init method.
- Enhanced translate_error method to catch additional exceptions.
- Updated all overloads of computew to include error handling via translate_error.
- computew_mixed_type methods now throw a deepmd::deepmd_exception.

Assessment against linked issues

Objective Addressed Explanation
Ensure correct GPU device selection to avoid VRAM waste (#4171)
Improve error handling for GPU-related exceptions (#4171)

Possibly related PRs

  • fix(tf): set visible_device_list for TF C++ #4172: This PR modifies the GPU device selection and configuration in the init method, which is directly related to the changes made in the DeepPotPT class regarding device management during initialization.

Suggested reviewers

  • wanghan-iapcm

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fa61d69 and 5f7707a.

📒 Files selected for processing (1)
  • source/api_cc/src/DeepPotPT.cc (1 hunks)

njzjz added 2 commits October 26, 2024 14:21
Signed-off-by: Jinzhe Zeng <[email protected]>
Signed-off-by: Jinzhe Zeng <[email protected]>
Copy link

codecov bot commented Oct 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.23%. Comparing base (fa61d69) to head (9bee6f4).
Report is 168 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4261   +/-   ##
=======================================
  Coverage   84.23%   84.23%           
=======================================
  Files         549      549           
  Lines       51462    51463    +1     
  Branches     3051     3051           
=======================================
+ Hits        43348    43349    +1     
- Misses       7153     7154    +1     
+ Partials      961      960    -1     

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

@njzjz njzjz marked this pull request as ready for review October 26, 2024 21:27
@njzjz njzjz requested a review from wanghan-iapcm October 26, 2024 21:27
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: 1

🧹 Outside diff range and nitpick comments (1)
source/api_cc/src/DeepPotPT.cc (1)

Line range hint 429-456: Consider documenting unimplemented methods.

While throwing exceptions for unimplemented methods is appropriate, it would be helpful to:

  1. Document why these methods are not implemented
  2. Provide guidance on alternatives in the error message

Consider enhancing the error message:

-  throw deepmd::deepmd_exception("computew_mixed_type is not implemented");
+  throw deepmd::deepmd_exception("computew_mixed_type is not implemented. Please use the standard compute methods with consistent types instead.");
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ba015a1 and 9bee6f4.

📒 Files selected for processing (1)
  • source/api_cc/src/DeepPotPT.cc (1 hunks)
🔇 Additional comments (3)
source/api_cc/src/DeepPotPT.cc (3)

Line range hint 15-27: LGTM: Comprehensive error handling implementation.

The error handling implementation properly catches different PyTorch exception types and provides clear context in error messages. This will help with debugging issues in the PyTorch backend.


Line range hint 391-428: LGTM: Well-implemented compute methods with proper error handling.

The compute implementations demonstrate good practices:

  • Type-safe template implementations
  • Consistent error handling through translate_error
  • Proper memory management for both CPU and GPU tensors

83-85: Verify VRAM usage improvement.

While the device selection changes are a step towards addressing the VRAM wastage issue (#4171), we should verify that this actually reduces VRAM usage in multi-GPU setups.

✅ Verification successful

Let me analyze the results and generate additional verification scripts to better understand the VRAM management.

The results will help us verify if proper device selection and memory management are implemented throughout the code to prevent VRAM wastage.


Let me run one more verification to check the tensor device management in the codebase.


Device selection and tensor management properly address VRAM wastage

The implementation effectively manages VRAM usage in multi-GPU setups through:

  • Proper device selection using gpu_id = gpu_rank % gpu_num to distribute load across available GPUs
  • Consistent device management with all tensors explicitly moved to the selected device using .to(device)
  • Clean initialization and fallback to CPU when GPU is unavailable
  • Proper scoping of GPU tensors ensuring memory is released after use
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Look for other GPU memory management related code
# that might need similar device selection logic

# Search for CUDA memory operations
rg -l "cuda|gpu|device|memory" --type cpp

# Search for tensor creation patterns that might allocate GPU memory
ast-grep --pattern 'torch::from_blob($$$).to(device)'

Length of output: 5033


Script:

#!/bin/bash
# Check for device selection and memory management patterns in DeepPotPT.cc
rg -A 5 "DPSetDevice|cudaSetDevice" source/api_cc/src/DeepPotPT.cc

# Look for device initialization and cleanup
rg -A 5 "init|cleanup|delete|free" source/api_cc/src/DeepPotPT.cc

# Check if there are any other CUDA memory management functions
rg "cuda.*Malloc|cuda.*Free|cuda.*Memory" source/api_cc/src/DeepPotPT.cc

Length of output: 1414


Script:

#!/bin/bash
# Check tensor device management and memory operations
rg -B 2 -A 2 "\.to\(device\)" source/api_cc/src/DeepPotPT.cc

# Look for device variable initialization and usage
rg -B 2 "torch::Device" source/api_cc/src/DeepPotPT.cc

# Check GPU memory management in the constructor/initialization
rg -A 10 "gpu_rank|gpu_num" source/api_cc/src/DeepPotPT.cc

Length of output: 3804

@njzjz njzjz added this pull request to the merge queue Oct 28, 2024
Merged via the queue into deepmodeling:devel with commit 04e1159 Oct 28, 2024
60 checks passed
@njzjz njzjz deleted the set-device-pt branch October 28, 2024 21:11
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.

[BUG] VRAM is wasted when running Lammps with multiple GPUs
2 participants