Skip to content

Conversation

@HydrogenSulfate
Copy link
Collaborator

@HydrogenSulfate HydrogenSulfate commented May 7, 2025

add Estimated Time of Arrival for pytorch backend which is convenient when training model(to avoid affecting performance, synchronization was not used for timing, so it will not be very precise).

Summary by CodeRabbit

  • New Features
    • Training progress messages now optionally display an estimated time of arrival (ETA) for completion, providing users with clearer expectations during training.
  • Improvements
    • Enhanced accuracy of ETA calculations in training logs for better progress tracking.

Copilot AI review requested due to automatic review settings May 7, 2025 09:41
@github-actions github-actions bot added the Python label May 7, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds an Estimated Time of Arrival (ETA) message for the PyTorch backend’s training logs and aligns the related formatting functions across different training modules.

  • Added ETA computation and logging in deepmd/pt/train/training.py.
  • Updated deepmd/pd/train/training.py to replace the deprecated _step_id with display_step_id and remove a -1 offset in the ETA calculation.
  • Modified deepmd/loggers/training.py to support an optional ETA parameter in the training message.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
deepmd/pt/train/training.py Adds ETA calculation and includes it in log messages.
deepmd/pd/train/training.py Updates ETA calculation by replacing _step_id with display_step_id and removing the -1 offset.
deepmd/loggers/training.py Updates format_training_message to optionally include ETA information.
Comments suppressed due to low confidence (1)

deepmd/pd/train/training.py:850

  • The removal of the '-1' offset in the ETA calculation changes the expected result. Please confirm if this off-by-one adjustment was intentional.
                        (self.num_steps - display_step_id) / self.disp_freq * train_time

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 7, 2025

📝 Walkthrough

Walkthrough

The changes introduce an optional ETA (estimated time of arrival) display to training progress logs. The format_training_message function is updated to accept and format an ETA. Code in training modules is refactored to use this centralized function, with local implementations removed and ETA calculations adjusted for accuracy and consistency.

Changes

File(s) Change Summary
deepmd/loggers/training.py Updated format_training_message to accept an optional ETA parameter and format it using datetime.timedelta. Added import of datetime.
deepmd/pd/train/training.py Removed local format_training_message and datetime import. Now imports format_training_message from logger module. Adjusted ETA calculation to use display_step_id for accuracy.
deepmd/pt/train/training.py Added ETA calculation in log_loss_valid and passed it to format_training_message during training log output. No other logic changed.

Sequence Diagram(s)

sequenceDiagram
    participant Trainer
    participant Logger

    Trainer->>Logger: format_training_message(batch, wall_time, eta)
    Logger-->>Trainer: Formatted message with optional ETA
    Trainer->>Console: Output training progress message
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 01c3c16 and dfd08cf.

📒 Files selected for processing (3)
  • deepmd/loggers/training.py (2 hunks)
  • deepmd/pd/train/training.py (2 hunks)
  • deepmd/pt/train/training.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
deepmd/pt/train/training.py (1)
deepmd/loggers/training.py (1)
  • format_training_message (8-17)
deepmd/pd/train/training.py (1)
deepmd/loggers/training.py (1)
  • format_training_message (8-17)
⏰ Context from checks skipped due to timeout of 90000ms (30)
  • GitHub Check: Test Python (6, 3.12)
  • GitHub Check: Test Python (6, 3.9)
  • GitHub Check: Test Python (5, 3.12)
  • GitHub Check: Test Python (5, 3.9)
  • GitHub Check: Test Python (4, 3.12)
  • GitHub Check: Build wheels for cp310-manylinux_aarch64
  • 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: Build wheels for cp311-macosx_arm64
  • GitHub Check: Build wheels for cp311-macosx_x86_64
  • GitHub Check: Test Python (2, 3.12)
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
  • GitHub Check: Build C++ (clang, clang)
  • GitHub Check: Test Python (2, 3.9)
  • GitHub Check: Build C++ (rocm, rocm)
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
  • GitHub Check: Test Python (1, 3.12)
  • GitHub Check: Test Python (1, 3.9)
  • GitHub Check: Test C++ (false)
  • GitHub Check: Build C++ (cuda120, cuda)
  • GitHub Check: Analyze (python)
  • GitHub Check: Test C++ (true)
  • GitHub Check: Build C library (2.14, >=2.5.0rc0,<2.15, libdeepmd_c_cu11.tar.gz)
  • GitHub Check: Build C++ (cuda, cuda)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Analyze (c-cpp)
  • GitHub Check: Build C++ (cpu, cpu)
  • GitHub Check: Build C library (2.18, libdeepmd_c.tar.gz)
🔇 Additional comments (8)
deepmd/loggers/training.py (3)

2-2: Clean import addition for ETA feature.

Adding the datetime module properly supports the new ETA formatting functionality.


11-12: Well-designed optional parameter addition.

Adding the optional eta parameter with a default value of None ensures backward compatibility with existing code.


14-17: Good implementation of ETA formatting.

The implementation correctly:

  1. Handles the base message construction
  2. Checks if eta is an integer before adding it
  3. Formats eta as a human-readable timedelta

This provides a clean, readable ETA display format in the logs.

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

902-904: Effective ETA calculation logic.

The ETA calculation uses a common and reliable approach:

  • Estimates remaining time based on current batch processing time
  • Scales by the number of remaining batches
  • Correctly converts to an integer value

This provides users with a helpful estimate of when training will complete.


909-910: Proper integration with message formatting.

The calculated ETA is correctly passed to the format_training_message function, enabling a consistent display format.

deepmd/pd/train/training.py (3)

32-32: Good centralization of formatting functionality.

Importing format_training_message from the central logging module instead of implementing it locally ensures consistency across backends.


849-851: Consistent ETA calculation across backends.

The ETA calculation logic matches the implementation in the PyTorch backend, ensuring that users get a consistent experience regardless of which backend they use.


853-857: Proper integration with message formatting.

The calculated ETA is correctly passed to the format_training_message function, completing the implementation of this feature for the PD backend.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@HydrogenSulfate HydrogenSulfate changed the title [pt] add eta message for pt backend feat(pt) add eta message for pt backend May 7, 2025
@HydrogenSulfate HydrogenSulfate changed the title feat(pt) add eta message for pt backend feat(pt): add eta message for pt backend May 7, 2025
@codecov
Copy link

codecov bot commented May 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.81%. Comparing base (01c3c16) to head (dfd08cf).
⚠️ Report is 80 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4725      +/-   ##
==========================================
- Coverage   84.81%   84.81%   -0.01%     
==========================================
  Files         696      696              
  Lines       67264    67262       -2     
  Branches     3541     3540       -1     
==========================================
- Hits        57047    57045       -2     
  Misses       9085     9085              
  Partials     1132     1132              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@njzjz njzjz added this pull request to the merge queue May 8, 2025
Merged via the queue into deepmodeling:devel with commit a5b1b1f May 8, 2025
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.

2 participants