Skip to content

Conversation

@njzjz
Copy link
Member

@njzjz njzjz commented Feb 6, 2025

In another OP which is not in this PR, @iProzd has triggered a situation where he used the CUDA-compiled PyTorch along with the CPU version of customized OP libraries. Then the OP gave incorrect results since it didn't do any computation.

Summary by CodeRabbit

  • Bug Fixes
    • Improved error messaging for scenarios where GPU operations are attempted without proper support, ensuring you receive clear notifications while CPU functionality remains unaffected.

@iProzd has triggered a situtation where he used the CUDA-compiled PyTorch along with CPU version of customized OP libraries, and then the OP gave incorrect results since it didn't do any computation.

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

Copilot wasn't able to review any files in this pull request.

Files not reviewed (1)
  • source/op/pt/tabulate_multi_device.cc: Language not supported

@github-actions github-actions bot added the OP label Feb 6, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 6, 2025

📝 Walkthrough

Walkthrough

The changes add error handling in several functions of the multi-device operation module. When a function is called with a GPU tensor while GPU support is disabled, the code now throws a runtime error with an explicit message. For CPU tensors, the existing execution path remains intact, ensuring standard computation without interruption.

Changes

File Change Summary
source/.../tabulate_multi_device.cc Added an #else clause in functions (TabulateFusionSeAForward, TabulateFusionSeAGradForward, TabulateFusionSeAGradGradForward, TabulateFusionSeTForward, etc.) to throw a std::runtime_error if a GPU tensor is used without GPU support. CPU handling remains unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Operation
    Caller->>Operation: Call TabulateFusionSeX(...)
    alt Input tensor is on GPU and GPU support disabled
       Operation-->>Caller: Throw runtime_error("GPU support not enabled")
    else Input tensor is on CPU
       Operation-->>Caller: Compute result normally
    end
Loading

Suggested labels

Python, CUDA

Suggested reviewers

  • iProzd
  • wanghan-iapcm

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 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 228062c and 116ca84.

📒 Files selected for processing (1)
  • source/op/pt/tabulate_multi_device.cc (9 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: Test Python (6, 3.12)
  • GitHub Check: Test Python (6, 3.9)
  • GitHub Check: Test Python (5, 3.12)
  • GitHub Check: Test Python (5, 3.9)
  • GitHub Check: Test Python (4, 3.12)
  • GitHub Check: Test Python (4, 3.9)
  • GitHub Check: Build wheels for cp310-manylinux_aarch64
  • GitHub Check: Build wheels for cp311-win_amd64
  • GitHub Check: Test Python (3, 3.12)
  • GitHub Check: Test Python (3, 3.9)
  • GitHub Check: Build wheels for cp311-macosx_arm64
  • GitHub Check: Test Python (2, 3.12)
  • GitHub Check: Build wheels for cp311-macosx_x86_64
  • GitHub Check: Test Python (2, 3.9)
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
  • GitHub Check: Test Python (1, 3.12)
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
  • GitHub Check: Build C library (2.14, >=2.5.0rc0,<2.15, libdeepmd_c_cu11.tar.gz)
  • GitHub Check: Test Python (1, 3.9)
🔇 Additional comments (2)
source/op/pt/tabulate_multi_device.cc (2)

64-67: LGTM! Error handling for GPU tensors is well implemented.

The error handling is consistently implemented across all functions, throwing a clear and descriptive runtime error when a GPU tensor is used without GPU support being enabled. This aligns well with the PR objectives and prevents silent failures.

Also applies to: 117-120, 177-180, 227-230, 273-276, 367-370, 407-410, 447-450


1-996: Consider adding tests for the new error handling.

To ensure robustness, consider adding tests that verify:

  1. An error is thrown when using GPU tensors without GPU support
  2. CPU tensors continue to work correctly
  3. GPU tensors work correctly when GPU support is enabled

Would you like me to help generate test cases for these scenarios?

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 Feb 6, 2025

Codecov Report

Attention: Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.

Project coverage is 84.60%. Comparing base (228062c) to head (116ca84).
Report is 62 commits behind head on devel.

Files with missing lines Patch % Lines
source/op/pt/tabulate_multi_device.cc 0.00% 6 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4582      +/-   ##
==========================================
- Coverage   84.61%   84.60%   -0.01%     
==========================================
  Files         680      680              
  Lines       64467    64473       +6     
  Branches     3538     3538              
==========================================
- Hits        54547    54546       -1     
- Misses       8780     8786       +6     
- Partials     1140     1141       +1     

☔ 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 added this pull request to the merge queue Feb 7, 2025
Merged via the queue into deepmodeling:devel with commit f01fa53 Feb 7, 2025
60 checks passed
@njzjz njzjz deleted the throw-error-gpu-tensor-cpu-op-library branch February 7, 2025 04:43
@njzjz njzjz added this to the v3.0.2 milestone Feb 9, 2025
njzjz added a commit to njzjz/deepmd-kit that referenced this pull request Feb 9, 2025
…eling#4582)

In another OP which is not in this PR, @iProzd has triggered a situation
where he used the CUDA-compiled PyTorch along with the CPU version of
customized OP libraries. Then the OP gave incorrect results since it
didn't do any computation.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved error messaging for scenarios where GPU operations are
attempted without proper support, ensuring you receive clear
notifications while CPU functionality remains unaffected.

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

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
(cherry picked from commit f01fa53)
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.

3 participants