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: prevent from printing additional header in lcurve.out on resuming #4511

Closed
wants to merge 2 commits into from

Conversation

caic99
Copy link
Member

@caic99 caic99 commented Dec 26, 2024

Summary by CodeRabbit

  • Bug Fixes
    • Improved logging control during training by adjusting header printing when resuming training.
    • Enhanced data handling to ensure seamless continuation of training and validation processes when data is exhausted.

Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

📝 Walkthrough

Walkthrough

The changes in the deepmd/pt/train/training.py file focus on modifying the Trainer class constructor and get_data method. The primary modifications involve adjusting the initialization of the self.lcurve_should_print_header attribute to depend on the training restart status and enhancing the data loading mechanism to handle scenarios where training or validation data is exhausted. These changes aim to improve the robustness of the training process by ensuring proper data iteration and logging behavior.

Changes

File Change Summary
deepmd/pt/train/training.py - Modified self.lcurve_should_print_header initialization to depend on self.restart_training
- Updated get_data method to handle data loader exhaustion and iterator reinitialization

Sequence Diagram

sequenceDiagram
    participant Trainer
    participant DataLoader
    participant Iterator

    Trainer->>Trainer: Initialize training
    alt Is Restart Training
        Trainer->>Trainer: Set lcurve_should_print_header to False
    else New Training
        Trainer->>Trainer: Set lcurve_should_print_header to True
    end

    Trainer->>DataLoader: Get data
    alt Data Exhausted
        DataLoader->>Iterator: Reinitialize
        Iterator-->>DataLoader: Reset iterator
    end
    DataLoader-->>Trainer: Return batch data
Loading

The sequence diagram illustrates the modified training initialization and data loading process, highlighting the conditional header printing and data loader handling when training is resumed or data is exhausted.


📜 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 3cecca4 and 3ccbbc2.

📒 Files selected for processing (1)
  • deepmd/pt/train/training.py (1 hunks)
🔇 Additional comments (2)
deepmd/pt/train/training.py (2)

148-150: LGTM! The header printing logic is now correctly controlled.

The initialization of lcurve_should_print_header based on not self.restart_training ensures that the header is only printed when starting a new training session, not when resuming. This change directly addresses the PR objective.


Line range hint 579-603: LGTM! Robust data handling implementation.

The data handling logic in get_data method properly manages data exhaustion scenarios by:

  1. Catching StopIteration exceptions
  2. Refreshing the data loader status
  3. Reinitializing the buffered iterator

This implementation ensures seamless training continuation for both single-task and multi-task scenarios.

Also applies to: 604-631


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 Dec 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.59%. Comparing base (3cecca4) to head (3ccbbc2).
Report is 5 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4511   +/-   ##
=======================================
  Coverage   84.59%   84.59%           
=======================================
  Files         675      675           
  Lines       63575    63574    -1     
  Branches     3486     3486           
=======================================
  Hits        53779    53779           
+ Misses       8671     8670    -1     
  Partials     1125     1125           

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

@wanghan-iapcm wanghan-iapcm requested a review from njzjz December 26, 2024 05:31
Copy link
Member

@njzjz njzjz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I don't suggest so, as the checkpoint is not saved every steps. You may see 10000 10100 (restart) 10000 10100. It's not clear if the title is removed.

  2. All backends should have the same behavior.

@caic99 caic99 closed this Dec 27, 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.

2 participants