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

chore: ensure GPU is available in GPU tests #4191

Closed
wants to merge 3 commits into from

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Oct 7, 2024

Summary by CodeRabbit

  • New Features
    • Enhanced testing framework to check GPU availability for CUDA in both PyTorch and TensorFlow environments.
    • Introduced a new variable TEST_DEVICE for improved testing configuration.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

Warning

Rate limit exceeded

@njzjz has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 19 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 15e69a8 and f6099d6.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes introduce a new import statement for TEST_DEVICE from the ..common module in two files: source/tests/pt/__init__.py and source/tests/tf/__init__.py. Both files include a conditional check to determine if TEST_DEVICE is set to "cuda". If so, they assert the availability of the GPU for testing purposes, ensuring that the testing framework can utilize GPU resources appropriately based on the specified test device.

Changes

File Change Summary
source/tests/pt/init.py Added import for TEST_DEVICE from ..common. Conditional check for "cuda" and GPU availability assertion.
source/tests/tf/init.py Added import for TEST_DEVICE from ..common. Conditional check for "cuda" and GPU availability assertion.

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 (2)
source/tests/tf/__init__.py (2)

6-8: LGTM: Conditional block for GPU testing is well-implemented.

The conditional import of TensorFlow when TEST_DEVICE is "cuda" is a good practice. It avoids unnecessary imports when GPU testing is not required. The comment above the block clearly explains its purpose.

Consider adding a brief comment explaining why TensorFlow is imported only in this case, for better code documentation.

 # ensure GPU is used when testing GPU code
 if TEST_DEVICE == "cuda":
+    # Import TensorFlow only when GPU testing is required
     import tensorflow as tf

10-10: GPU availability check is good, but consider future-proofing.

The assertion ensures that a GPU is available when TEST_DEVICE is set to "cuda", which is crucial for GPU testing. However, tf.test.is_gpu_available() is deprecated in newer versions of TensorFlow.

Consider using the following alternative for better future compatibility:

-    assert tf.test.is_gpu_available()
+    assert len(tf.config.list_physical_devices('GPU')) > 0

This change uses the recommended method to check for GPU availability in recent TensorFlow versions.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d667929 and 15e69a8.

📒 Files selected for processing (2)
  • source/tests/pt/init.py (1 hunks)
  • source/tests/tf/init.py (1 hunks)
🧰 Additional context used
🔇 Additional comments (5)
source/tests/tf/__init__.py (2)

2-4: LGTM: Import statement looks good.

The addition of TEST_DEVICE import from ..common is appropriate for the context of GPU testing. The use of relative import is consistent with Python best practices.


1-10: Overall, the changes effectively implement GPU testing setup.

The modifications in this file successfully achieve the PR objective of ensuring GPU availability for GPU tests. The implementation is sound, with appropriate use of imports and conditional checks. The suggestions provided are minor and aim to improve clarity and future compatibility.

source/tests/pt/__init__.py (3)

4-6: LGTM: Import statement is correct and appropriate.

The import of TEST_DEVICE from the parent package's common module is well-structured and follows good practices for organizing test configurations.


13-15: LGTM: GPU availability check is appropriate.

The conditional check ensures that CUDA is available when TEST_DEVICE is set to "cuda". This aligns well with the PR objective and is a good practice for GPU-related tests.


11-11: ⚠️ Potential issue

Consider removing or updating the default device setting.

The current line sets the default device to a non-existent CUDA device:

torch.set_default_device("cuda:9999999")

This setting might interfere with the newly added GPU availability check. Consider either removing this line or updating it to use a valid device index or TEST_DEVICE.

To verify the impact of this setting, we can check if it's used elsewhere in the codebase:

✅ Verification successful

Default device setting requires update or removal.

The torch.set_default_device("cuda:9999999") in source/tests/pt/__init__.py sets an invalid CUDA device index. Please update it to a valid device index or use TEST_DEVICE to prevent potential interference with GPU availability checks.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for usage of set_default_device in Python files
rg --type python 'torch\.set_default_device'

Length of output: 77


Script:

#!/bin/bash
# Search for usage of set_default_device in Python files
rg 'torch\.set_default_device' -g '*.py'

Length of output: 111

@njzjz njzjz added the Test CUDA Trigger test CUDA workflow label Oct 7, 2024
@github-actions github-actions bot added the Python label Oct 7, 2024
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz added Test CUDA Trigger test CUDA workflow and removed Test CUDA Trigger test CUDA workflow labels Oct 7, 2024
@github-actions github-actions bot removed the Test CUDA Trigger test CUDA workflow label Oct 7, 2024
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz added the Test CUDA Trigger test CUDA workflow label Oct 7, 2024
@github-actions github-actions bot removed the Test CUDA Trigger test CUDA workflow label Oct 7, 2024
Copy link

codecov bot commented Oct 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.45%. Comparing base (d667929) to head (f6099d6).
Report is 116 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4191      +/-   ##
==========================================
- Coverage   83.45%   83.45%   -0.01%     
==========================================
  Files         537      537              
  Lines       52148    52148              
  Branches     3047     3047              
==========================================
- Hits        43520    43518       -2     
  Misses       7683     7683              
- Partials      945      947       +2     

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

@njzjz njzjz closed this Nov 17, 2024
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.

1 participant