Skip to content

Conversation

@caic99
Copy link
Member

@caic99 caic99 commented Mar 24, 2025

Parsing pytorch version and determining if CPU fused optimizer is supported would be verbose, and the time for optimizer update time is usually much more smaller than forward/backward time when training on CPU. So, this PR disables using fused optimizer for CPU backend.
The issue only affects PyTorch backed.
Fix #4667

Summary by CodeRabbit

  • Bug Fixes

    • Adjusted training optimizer behavior to conditionally apply optimal settings based on your device type, helping improve performance on both CPU and non-CPU hardware.
  • Refactor

    • Enhanced code organization for the optimizer setup to boost clarity and maintainability.

Copilot AI review requested due to automatic review settings March 24, 2025 03:10
@caic99 caic99 requested a review from njzjz March 24, 2025 03:10
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 disables the fused optimizer for CPU backends in the PyTorch training module.

  • Conditionally disables the fused parameter based on DEVICE type.
  • Updates the torch.optim.Adam instantiation to support CPU-specific behavior.
Comments suppressed due to low confidence (1)

deepmd/pt/train/training.py:599

  • [nitpick] Consider using a clearer boolean expression for the 'fused' parameter, for example, 'fused=(DEVICE.type != "cpu")', to improve readability.
fused=False if DEVICE.type == "cpu" else True,

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 24, 2025

📝 Walkthrough

Walkthrough

The changes modify the initialization of the Adam optimizer in the warm_up_linear function by conditionally setting the fused parameter based on the device type. Now, if the device is a CPU, the optimizer is initialized with fused=False; otherwise, fused=True is applied. Additionally, the formatting of the initialization parameters has been improved for better readability while leaving the core functionality unchanged.

Changes

File Change Summary
deepmd/pt/train/training.py In the warm_up_linear function, updated the optimizer initialization to conditionally set fused=False for CPU devices and fused=True for non-CPU devices; improved formatting.

Sequence Diagram(s)

sequenceDiagram
    participant Trainer as warm_up_linear()
    participant Device as Device Checker
    participant Optimizer as torch.optim.Adam
    Trainer->>Device: Check device type
    Device-->>Trainer: Return "cpu" or "gpu/other"
    alt If device is CPU
      Trainer->>Optimizer: Initialize Adam(fused=False, …)
    else Otherwise
      Trainer->>Optimizer: Initialize Adam(fused=True, …)
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix RuntimeError due to fused=True on CPU devices [#4667]

Possibly related PRs

Suggested labels

Python

Suggested reviewers

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

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

🧹 Nitpick comments (1)
deepmd/pt/train/training.py (1)

597-599: Good refactoring for device-dependent fused optimization.

The changes correctly implement device-dependent fused optimization by disabling it for CPU devices. This is a solid approach since optimizer updates take significantly less time compared to forward/backward passes during training on CPUs.

The code could be slightly improved for readability by using a more idiomatic Python pattern.

-                fused=False if DEVICE.type == "cpu" else True,
+                fused=not (DEVICE.type == "cpu"),
🧰 Tools
🪛 Ruff (0.8.2)

599-599: Use not ... instead of False if ... else True

Replace with not ...

(SIM211)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c9bfa79 and a690eaf.

📒 Files selected for processing (1)
  • deepmd/pt/train/training.py (1 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
deepmd/pt/train/training.py

599-599: Use not ... instead of False if ... else True

Replace with not ...

(SIM211)

⏰ Context from checks skipped due to timeout of 90000ms (29)
  • 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: Build wheels for cp310-manylinux_aarch64
  • GitHub Check: Test Python (4, 3.12)
  • GitHub Check: Build wheels for cp311-win_amd64
  • GitHub Check: Test Python (4, 3.9)
  • GitHub Check: Test Python (3, 3.12)
  • GitHub Check: Build wheels for cp311-macosx_arm64
  • GitHub Check: Build C++ (clang, clang)
  • GitHub Check: Test Python (3, 3.9)
  • GitHub Check: Build wheels for cp311-macosx_x86_64
  • GitHub Check: Build C++ (rocm, rocm)
  • GitHub Check: Test Python (2, 3.12)
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
  • GitHub Check: Analyze (python)
  • GitHub Check: Build C++ (cuda120, cuda)
  • GitHub Check: Build C library (2.14, >=2.5.0rc0,<2.15, libdeepmd_c_cu11.tar.gz)
  • GitHub Check: Test Python (2, 3.9)
  • GitHub Check: Build wheels for cp311-manylinux_x86_64
  • GitHub Check: Test C++ (false)
  • GitHub Check: Build C++ (cuda, cuda)
  • GitHub Check: Build C library (2.18, libdeepmd_c.tar.gz)
  • GitHub Check: Test Python (1, 3.12)
  • GitHub Check: Analyze (c-cpp)
  • GitHub Check: Test C++ (true)
  • GitHub Check: Build C++ (cpu, cpu)
  • GitHub Check: Test Python (1, 3.9)

@codecov
Copy link

codecov bot commented Mar 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.81%. Comparing base (c9bfa79) to head (a690eaf).
Report is 81 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4669   +/-   ##
=======================================
  Coverage   84.81%   84.81%           
=======================================
  Files         692      692           
  Lines       66360    66360           
  Branches     3539     3538    -1     
=======================================
  Hits        56282    56282           
  Misses       8937     8937           
  Partials     1141     1141           

☔ 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 Mar 24, 2025
Merged via the queue into deepmodeling:devel with commit 8402cf1 Mar 24, 2025
60 checks passed
@caic99 caic99 deleted the fix-cpu-fused-adam branch March 24, 2025 07:53
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] PT: RuntimeError: fused=True requires all the params to be floating point Tensors of supported devices: ['cuda', 'xpu', 'privateuseone'].

2 participants