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 average training time for restart #4212

Merged
merged 1 commit into from
Oct 15, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Oct 14, 2024

Fix #4208.

Summary by CodeRabbit

  • New Features

    • Enhanced training step management and logging for improved tracking.
    • Updated average training time calculations for more accurate reporting.
    • Refined model and checkpoint saving logic based on new tracking metrics.
    • Improved logging clarity for learning rates and losses.
  • Bug Fixes

    • Resolved issues related to inaccurate training time and logging conditions.
  • Chores

    • General code cleanup for better readability and organization.

Fix deepmodeling#4208.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz requested review from iProzd and wanghan-iapcm October 14, 2024 19:57
@njzjz njzjz linked an issue Oct 14, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Oct 14, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request focus on improving the training processes in the Trainer and DPTrainer classes found in deepmd/pt/train/training.py and deepmd/tf/train/trainer.py. Key enhancements include refined management of training steps, improved calculations for average training time, updated logic for model and checkpoint saving, and overall logging improvements. Additionally, minor code cleanup has been performed to enhance readability.

Changes

Files Change Summary
deepmd/pt/train/training.py Adjusted training step management and logging; updated average training time calculation; refined model saving logic; enhanced logging; minor code cleanup.
deepmd/tf/train/trainer.py Introduced new variables for batch tracking; modified average training time calculation; updated checkpoint saving logic; improved logging; minor code cleanup.

Assessment against linked issues

Objective Addressed Explanation
Update average training time calculation (#4208)

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

🧹 Outside diff range and nitpick comments (1)
deepmd/tf/train/trainer.py (1)

602-611: Enhanced average training time calculation

The calculation of average training time has been improved to provide more accurate results. It now uses the elapsed_batch variable and excludes the first display interval from the calculation when there are enough batches.

However, there's a small improvement that can be made to enhance readability:

Consider extracting the complex condition and calculation into a separate function for better readability. For example:

def calculate_average_training_time(total_time, elapsed_batch, disp_freq):
    if elapsed_batch >= 2 * disp_freq:
        return total_time / (elapsed_batch - disp_freq)
    else:
        return total_time / elapsed_batch

# Then in the logging statement:
avg_time = calculate_average_training_time(total_train_time, elapsed_batch, self.disp_freq)
log.info(
    "average training time: %.4f s/batch (exclude first %d batches)",
    avg_time,
    self.disp_freq if elapsed_batch >= 2 * self.disp_freq else 0
)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a1f8672 and 999dd56.

📒 Files selected for processing (2)
  • deepmd/pt/train/training.py (3 hunks)
  • deepmd/tf/train/trainer.py (3 hunks)
🧰 Additional context used
🔇 Additional comments (5)
deepmd/tf/train/trainer.py (4)

419-420: New variables introduced to track training progress

The addition of start_batch and elapsed_batch variables improves the accuracy of tracking the training progress. This change allows for a more precise calculation of the elapsed batches, especially in scenarios where training is resumed from a checkpoint.


557-560: Improved logic for calculating total training time

The updated condition for calculating the total training time is more accurate. It now excludes the first training interval (which might be inaccurate due to initialization overhead) when the training has progressed beyond the first display interval, or includes it if the total elapsed batches are less than twice the display frequency.


617-618: Simplified average training time calculation for short training sessions

The calculation for average training time when the total elapsed batches are less than twice the display frequency has been simplified. This provides a more straightforward representation of the average time for shorter training sessions.


Line range hint 419-618: Summary of improvements to training time calculation and progress tracking

The changes in this file significantly improve the accuracy of training time calculations and progress tracking, addressing the issue mentioned in PR #4208. Key improvements include:

  1. Introduction of start_batch and elapsed_batch variables for better batch counting.
  2. Updated logic for calculating total training time, excluding potential inaccuracies from the first training interval.
  3. Enhanced average training time calculation, providing more accurate results for both long and short training sessions.

These changes should resolve the reported issue of incorrect average training times, especially in scenarios involving training restarts. The implementation now provides a more reliable representation of the training progress and performance.

deepmd/pt/train/training.py (1)

892-894: Verify the logic for updating total_train_time.

The condition used to update self.total_train_time has been modified. Please ensure that this logic correctly accounts for cases when training is restarted, and that it accurately reflects the intended batches for timing calculations.

deepmd/pt/train/training.py Show resolved Hide resolved
Copy link

codecov bot commented Oct 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.49%. Comparing base (a1f8672) to head (999dd56).
Report is 188 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4212      +/-   ##
==========================================
- Coverage   83.50%   83.49%   -0.01%     
==========================================
  Files         541      541              
  Lines       52459    52463       +4     
  Branches     3047     3047              
==========================================
+ Hits        43804    43805       +1     
  Misses       7710     7710              
- Partials      945      948       +3     

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

@iProzd iProzd added this pull request to the merge queue Oct 15, 2024
Merged via the queue into deepmodeling:devel with commit 5c092e6 Oct 15, 2024
60 checks passed
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.

[BUG] average training time seems wrong
3 participants