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(pt): do not overwrite disp_file when restarting training #3985

Merged
merged 2 commits into from
Jul 16, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Jul 16, 2024

New contents should be appended when restarting

Summary by CodeRabbit

  • New Features
    • Improved training process by conditionally appending to files based on the restart_training flag.
    • Added functionality to create a record file when SAMPLER_RECORD is true.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz requested review from iProzd and wanghan-iapcm July 16, 2024 08:11
Copy link
Contributor

coderabbitai bot commented Jul 16, 2024

Walkthrough

Walkthrough

The recent changes to the deepmd/pt/train/training.py file enhance the run method by adding conditional logic for opening a file in append mode based on a restart_training flag. Additionally, a new file creation mechanism is introduced for recording purposes when the SAMPLER_RECORD flag is set.

Changes

Files Change Summary
deepmd/pt/train/training.py Modified the run method to conditionally open a file in append mode based on restart_training flag. Adjusted file opening logic and buffering. Added file creation for recording if SAMPLER_RECORD is true.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TrainingScript as training.py
    participant FileSystem

    User->>TrainingScript: Start training
    alt restart_training is true
        TrainingScript->>FileSystem: Open file in append mode
    else restart_training is false
        TrainingScript->>FileSystem: Open file in write mode
    end
    alt SAMPLER_RECORD is true
        TrainingScript->>FileSystem: Create file for recording
    end
    TrainingScript->>User: Training process starts
Loading

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

Comment on lines +633 to +637
open(
self.disp_file,
mode="w" if not self.restart_training else "a",
buffering=1,
)

Check warning

Code scanning / CodeQL

File is not always closed Warning

File is opened but is not closed.
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/pt/train/training.py Show resolved Hide resolved
@wanghan-iapcm wanghan-iapcm enabled auto-merge July 16, 2024 08:18
Copy link

codecov bot commented Jul 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.83%. Comparing base (399646e) to head (536f817).
Report is 106 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3985   +/-   ##
=======================================
  Coverage   82.83%   82.83%           
=======================================
  Files         522      522           
  Lines       50872    50872           
  Branches     3015     3015           
=======================================
  Hits        42142    42142           
  Misses       7795     7795           
  Partials      935      935           

☔ 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 Jul 16, 2024
Merged via the queue into deepmodeling:devel with commit 782f1e2 Jul 16, 2024
59 of 60 checks passed
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
…eling#3985)

New contents should be appended when restarting

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

## Summary by CodeRabbit

- **New Features**
- Improved training process by conditionally appending to files based on
the `restart_training` flag.
- Added functionality to create a record file when `SAMPLER_RECORD` is
true.

<!-- 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
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants