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

Perf: use fused Adam optimizer #4463

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Perf: use fused Adam optimizer #4463

merged 1 commit into from
Dec 18, 2024

Conversation

caic99
Copy link
Member

@caic99 caic99 commented Dec 9, 2024

This PR sets the Adam optimizer to use the fused=True parameter.
For the profiling result shown below, this modification brings an 2.75x improvement on optimizer update (22ms vs. 8ms) and ~3% improvement for total speed up (922ms vs. 892ms). The benchmark case is training a DPA-2 Q3 release model. Please note that the absolute time may differs between steps.

Before

image

After

image

Ref:

The foreach and fused implementations are typically faster than the for-loop, single-tensor implementation, with fused being theoretically fastest with both vertical and horizontal fusion. As such, if the user has not specified either flag (i.e., when foreach = fused = None), we will attempt defaulting to the foreach implementation when the tensors are all on CUDA. Why not fused? Since the fused implementation is relatively new, we want to give it sufficient bake-in time.

Summary by CodeRabbit

  • Bug Fixes

    • Improved optimizer performance during training by modifying the initialization of the Adam optimizer.
  • Documentation

    • Updated method signature for clarity in the Trainer class.

@github-actions github-actions bot added the Python label Dec 9, 2024
Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the optimizer initialization in the Trainer class located in deepmd/pt/train/training.py. The Adam optimizer is updated to include the fused=True argument, which may enhance performance during training. No other changes are made to the code structure or logic, and the overall functionality of the training process remains unchanged.

Changes

File Path Change Summary
deepmd/pt/train/training.py Updated Adam optimizer initialization to include fused=True in the Trainer class. Method signature of __init__ updated for clarity.

Possibly related PRs

  • perf: optimize training loop #4426: This PR modifies the Trainer class in the same file (deepmd/pt/train/training.py) and involves changes to the training loop, which may interact with the optimizer initialization, indicating a potential relationship in the context of training performance optimizations.

Suggested labels

Python

Suggested reviewers

  • njzjz

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

🧹 Outside diff range and nitpick comments (1)
deepmd/pt/train/training.py (1)

582-582: Great performance optimization!

The addition of fused=True to the Adam optimizer is a valuable performance improvement, showing significant speedups in both optimizer update time (2.75x) and total training time (3%).

However, since fused Adam is only available for CUDA tensors, we should add a CUDA availability check. Apply this diff:

-                self.wrapper.parameters(), lr=self.lr_exp.start_lr, fused=True
+                self.wrapper.parameters(),
+                lr=self.lr_exp.start_lr,
+                fused=torch.cuda.is_available()  # Enable fused Adam only when CUDA is available
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d162d0b and 1c8ccf6.

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

@caic99
Copy link
Member Author

caic99 commented Dec 9, 2024

Running with CPU is still possible with this parameter set.

Copy link

codecov bot commented Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.75%. Comparing base (d162d0b) to head (1c8ccf6).
Report is 5 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4463      +/-   ##
==========================================
- Coverage   83.75%   83.75%   -0.01%     
==========================================
  Files         667      667              
  Lines       61513    61515       +2     
  Branches     3486     3486              
==========================================
- Hits        51523    51521       -2     
- Misses       8865     8867       +2     
- Partials     1125     1127       +2     

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

@njzjz
Copy link
Member

njzjz commented Dec 13, 2024

For the profiling result shown below, this modification brings an 2.75x improvement on optimizer update (22ms vs. 8ms) and ~3% improvement for total speed up (922ms vs. 892ms). The benchmark case is training a DPA-2 Q3 release model. Please note that the absolute time may differs between steps.

It might be wrong to benchmark the time on the CPU since the GPU is asynchronous, which is the bottleneck.

@caic99
Copy link
Member Author

caic99 commented Dec 15, 2024

which is the bottleneck

@njzjz What you've mentioned is the general case for NN itself. However, for optimizer update in deepmd-kit, the bottleneck is at the CPU side. You can refer to the "GPU SM efficiency" row from the profiling plot.

@njzjz njzjz added this pull request to the merge queue Dec 17, 2024
Merged via the queue into deepmodeling:devel with commit 104fc36 Dec 18, 2024
60 checks passed
@caic99 caic99 deleted the fused-adam branch December 19, 2024 03:17
@njzjz njzjz added this to the v3.0.1 milestone Dec 21, 2024
njzjz pushed a commit to njzjz/deepmd-kit that referenced this pull request Dec 22, 2024
This PR sets the Adam optimizer to use the `fused=True` parameter.
For the profiling result shown below, this modification brings an 2.75x
improvement on optimizer update (22ms vs. 8ms) and ~3% improvement for
total speed up (922ms vs. 892ms). The benchmark case is training a DPA-2
Q3 release model. Please note that the absolute time may differs between
steps.

<details><summary>Before</summary>
<p>

![image](https://github.com/user-attachments/assets/d6b05a1d-6e6c-478d-921f-c497718bc551)

</p>
</details>

<details><summary>After</summary>
<p>

![image](https://github.com/user-attachments/assets/b216b919-094c-441f-96a7-146e1e3db483)

</p>
</details>

[Ref](https://pytorch.org/docs/stable/generated/torch.optim.Adam.html):
> The foreach and fused implementations are typically faster than the
for-loop, single-tensor implementation, with **fused being theoretically
fastest** with both vertical and horizontal fusion. As such, if the user
has not specified either flag (i.e., when foreach = fused = None), we
will attempt defaulting to the foreach implementation when the tensors
are all on CUDA. Why not fused? Since the fused implementation is
relatively new, we want to give it sufficient bake-in time.

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

## Summary by CodeRabbit

- **Bug Fixes**
- Improved optimizer performance during training by modifying the
initialization of the Adam optimizer.

- **Documentation**
	- Updated method signature for clarity in the `Trainer` class.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

(cherry picked from commit 104fc36)
njzjz pushed a commit that referenced this pull request Dec 23, 2024
This PR sets the Adam optimizer to use the `fused=True` parameter.
For the profiling result shown below, this modification brings an 2.75x
improvement on optimizer update (22ms vs. 8ms) and ~3% improvement for
total speed up (922ms vs. 892ms). The benchmark case is training a DPA-2
Q3 release model. Please note that the absolute time may differs between
steps.

<details><summary>Before</summary>
<p>

![image](https://github.com/user-attachments/assets/d6b05a1d-6e6c-478d-921f-c497718bc551)

</p>
</details>

<details><summary>After</summary>
<p>

![image](https://github.com/user-attachments/assets/b216b919-094c-441f-96a7-146e1e3db483)

</p>
</details>

[Ref](https://pytorch.org/docs/stable/generated/torch.optim.Adam.html):
> The foreach and fused implementations are typically faster than the
for-loop, single-tensor implementation, with **fused being theoretically
fastest** with both vertical and horizontal fusion. As such, if the user
has not specified either flag (i.e., when foreach = fused = None), we
will attempt defaulting to the foreach implementation when the tensors
are all on CUDA. Why not fused? Since the fused implementation is
relatively new, we want to give it sufficient bake-in time.

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

## Summary by CodeRabbit

- **Bug Fixes**
- Improved optimizer performance during training by modifying the
initialization of the Adam optimizer.

- **Documentation**
	- Updated method signature for clarity in the `Trainer` class.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

(cherry picked from commit 104fc36)
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