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: fix PT AutoBatchSize OOM bug and merge execute_all into base #4047

Merged
merged 4 commits into from
Aug 6, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Aug 5, 2024

Fix #4036. Fix #4037.

Summary by CodeRabbit

  • New Features

    • Improved batch processing methods to enhance compatibility with various array-like objects through Array API integration.
    • Added a new test suite to validate the functionality of the AutoBatchSize class under different conditions, ensuring robust behavior with GPU resources.
  • Bug Fixes

    • Removed the outdated execute_all method, streamlining batch execution processes.
  • Documentation

    • Updated minimum TensorFlow version requirement to 2.7 for backend compatibility.
    • Clarified installation instructions to reflect the updated TensorFlow version requirement.
  • Chores

    • Specified minimum NumPy version dependency as 1.21 in project configuration.

Copy link
Contributor

coderabbitai bot commented Aug 5, 2024

Walkthrough

Walkthrough

The changes primarily involve the removal of the execute_all method from the AutoBatchSize class, simplifying the batch processing logic. The batch handling functions have been updated to support a broader range of array types by integrating Array API compatibility. Additionally, unit tests for the AutoBatchSize functionality have been introduced, enhancing the robustness and reliability of batch processing features.

Changes

File Path Change Summary
deepmd/pt/utils/auto_batch_size.py Removed execute_all method, simplifying batch processing logic.
deepmd/utils/batch_size.py Updated execute_with_batch_size to utilize Array API compatibility, enhancing input flexibility.
source/tests/common/test_auto_batch_size.py Introduced unit tests for AutoBatchSize, validating behavior under various conditions.
doc/backend.md Updated minimum TensorFlow version requirement from 2.2 to 2.7.
doc/install/install-from-source.md Specified updated minimum TensorFlow version support from 2.2 to 2.7 in installation instructions.
pyproject.toml Changed numpy dependency to require version 1.21 or higher for compatibility with new features.

Assessment against linked issues

Objective Addressed Explanation
Runtime error handling improvements for batch processing (#4036) The removal of execute_all may introduce new issues without sufficient error handling.
Merge PT AutoBatchSize.execute_all into the common one (#4037) The method has been removed, addressing the merge suggestion.

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>.
    • 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 show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Outside diff range, codebase verification and nitpick comments (1)
deepmd/utils/batch_size.py (1)

159-160: Add a brief note about Array API compatibility.

To improve clarity, add a brief note in the docstring about the Array API compatibility.

+        This method is compatible with Array API, allowing it to handle various array-like objects.

deepmd/utils/batch_size.py Outdated Show resolved Hide resolved
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@github-actions github-actions bot added the Docs label Aug 5, 2024
njzjz and others added 2 commits August 5, 2024 17:08
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
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

deepmd/utils/batch_size.py Show resolved Hide resolved
Copy link

codecov bot commented Aug 5, 2024

Codecov Report

Attention: Patch coverage is 96.77419% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.94%. Comparing base (8201ebc) to head (9d38cb8).

Files Patch % Lines
deepmd/utils/batch_size.py 96.77% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4047      +/-   ##
==========================================
- Coverage   82.95%   82.94%   -0.02%     
==========================================
  Files         522      522              
  Lines       51039    51020      -19     
  Branches     3028     3028              
==========================================
- Hits        42338    42317      -21     
- Misses       7756     7757       +1     
- Partials      945      946       +1     

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

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Aug 6, 2024
Merged via the queue into deepmodeling:devel with commit cc274c4 Aug 6, 2024
60 checks passed
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
…epmodeling#4047)

Fix deepmodeling#4036. Fix deepmodeling#4037.

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


- **New Features**
- Improved batch processing methods to enhance compatibility with
various array-like objects through Array API integration.
- Added a new test suite to validate the functionality of the
`AutoBatchSize` class under different conditions, ensuring robust
behavior with GPU resources.

- **Bug Fixes**
- Removed the outdated `execute_all` method, streamlining batch
execution processes.

- **Documentation**
- Updated minimum TensorFlow version requirement to 2.7 for backend
compatibility.
- Clarified installation instructions to reflect the updated TensorFlow
version requirement.

- **Chores**
- Specified minimum NumPy version dependency as 1.21 in project
configuration.

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

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants