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: throw exception in consumer thread #4583

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

caic99
Copy link
Member

@caic99 caic99 commented Feb 7, 2025

This pull request includes changes to improve error handling in the dataloader.py files for both deepmd/pd/utils and deepmd/pt/utils. The most important changes are the addition of a try-except block to handle exceptions during the data loading process and signaling the end of iteration properly.

Error handling improvements:

  • deepmd/pd/utils/dataloader.py: Added a try-except block to catch exceptions during the iteration over the data source, and modified the signaling of the end of iteration to use StopIteration().
  • deepmd/pt/utils/dataloader.py: Added a try-except block to catch exceptions during the iteration over the data source, and ensured the end of iteration is signaled with StopIteration().

Summary by CodeRabbit

  • Bug Fixes
    • Improved robustness in background data processing. Errors encountered during data loading are now explicitly reported, and process completion is clearly signaled, ensuring more reliable operation.

@caic99 caic99 requested a review from iProzd February 7, 2025 06:25
@github-actions github-actions bot added the Python label Feb 7, 2025
Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

📝 Walkthrough

Walkthrough

The updates enhance the BackgroundConsumer.run() method in both the pd and pt dataloader modules. The iteration over the data source is now enclosed in a try block, allowing any exceptions that occur to be caught and enqueued. In addition, once the iteration is complete, an explicit StopIteration signal is pushed to the queue. These changes ensure that errors are propagated properly and the completion of the data stream is clearly indicated.

Changes

File(s) Change Summary
deepmd/../utils/dataloader.py (pd, pt) Updated BackgroundConsumer.run(): wraps iteration over _source in a try block, catches exceptions to enqueue them, and explicitly enqueues a StopIteration signal upon completion.

Sequence Diagram(s)

sequenceDiagram
  participant BC as BackgroundConsumer
  participant DS as Data Source
  participant Q as Queue

  BC->>DS: Start iterating over source
  alt Successful iteration
    DS-->>BC: Next item
    BC->>Q: Enqueue item
    BC-)DS: Continue iteration
  else Exception occurs
    DS-->>BC: Exception raised
    BC->>Q: Enqueue exception
  end
  BC->>Q: Enqueue StopIteration signal
Loading

📜 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 f01fa53 and 5d044a9.

📒 Files selected for processing (2)
  • deepmd/pd/utils/dataloader.py (1 hunks)
  • deepmd/pt/utils/dataloader.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: Test Python (6, 3.12)
  • 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: Test Python (3, 3.12)
  • GitHub Check: Build wheels for cp311-win_amd64
  • GitHub Check: Test Python (3, 3.9)
  • GitHub Check: Test Python (2, 3.12)
  • GitHub Check: Test Python (2, 3.9)
  • GitHub Check: Analyze (python)
  • GitHub Check: Test C++ (false)
  • GitHub Check: Build C library (2.14, >=2.5.0rc0,<2.15, libdeepmd_c_cu11.tar.gz)
  • GitHub Check: Test Python (1, 3.12)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Test C++ (true)
  • GitHub Check: Analyze (c-cpp)
  • GitHub Check: Test Python (1, 3.9)
  • GitHub Check: Build C library (2.18, libdeepmd_c.tar.gz)
🔇 Additional comments (2)
deepmd/pt/utils/dataloader.py (1)

221-227: LGTM! Improved error handling in consumer thread.

The changes properly handle exceptions in the consumer thread by:

  1. Propagating exceptions through the queue instead of silently failing
  2. Ensuring StopIteration is only sent after successful completion
deepmd/pd/utils/dataloader.py (1)

261-267: LGTM! Consistent error handling implementation.

The changes mirror the implementation in the pt dataloader, maintaining consistency across both modules while properly handling exceptions and completion signals.

✨ 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.

Copy link

codecov bot commented Feb 7, 2025

Codecov Report

Attention: Patch coverage is 66.66667% with 4 lines in your changes missing coverage. Please review.

Project coverage is 84.59%. Comparing base (f01fa53) to head (5d044a9).

Files with missing lines Patch % Lines
deepmd/pd/utils/dataloader.py 66.66% 2 Missing ⚠️
deepmd/pt/utils/dataloader.py 66.66% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4583      +/-   ##
==========================================
- Coverage   84.60%   84.59%   -0.01%     
==========================================
  Files         680      680              
  Lines       64473    64479       +6     
  Branches     3540     3540              
==========================================
+ Hits        54546    54547       +1     
- Misses       8786     8790       +4     
- Partials     1141     1142       +1     

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

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