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

feat(pt): support fine-tuning from random fitting #3914

Merged
merged 7 commits into from
Jun 28, 2024

Conversation

iProzd
Copy link
Collaborator

@iProzd iProzd commented Jun 26, 2024

Support fine-tuning from random fitting in single-from-single fine-tuning.

Summary by CodeRabbit

  • New Features

    • Introduced the ability to randomly initialize fitting nets for fine-tuning by setting the model branch to "RANDOM".
    • Added support for "RANDOM" model branches in multitask pre-trained model scenarios.
  • Documentation

    • Updated fine-tuning documentation to include details on handling fitting net weights and using the --model-branch RANDOM parameter.
  • Tests

    • Added tests to verify the random initialization of fitting nets and parameter closeness checks during fine-tuning.
    • Updated test cases to include "RANDOM" model branches in the output.

Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Walkthrough

Walkthrough

The recent changes introduce new functionality for handling the initialization of model branches in a deep learning model, specifically when fine-tuning with randomly chosen branches. The updates also ensure correct initialization of the fitting net based on predefined rules, and provide clearer documentation for these processes. Tests are updated accordingly to ensure these new functionalities are correctly implemented and verified.

Changes

File Path Change Summary
deepmd/pt/utils/finetune.py Added logic to handle RANDOM model branch for fine-tuning and updated conditions for model initialization.
source/tests/pt/test_training.py Included tests for random fitting initialization and updated trainer setups for new fine-tuning logic.
deepmd/pt/entrypoints/main.py Ensured RANDOM model name isn't used in multi-task mode and included it in the model display list.
doc/train/finetuning.md Documented the new fine-tuning processes and clarified handling of fitting net weights and model branches.
source/tests/pt/test_dp_show.py Added 'RANDOM' model branch to available branches in the checkpoint output test case.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Trainer
    participant Model
    participant FittingNet

    User->>Trainer: Configure fine-tuning with `--model-branch RANDOM`
    Trainer->>Model: Initialize
    Model->>FittingNet: Check `model_branch_from`
    alt model_branch_from is RANDOM
        FittingNet-->>FittingNet: Initialize with random weights
    else model_branch_from is pre-trained
        FittingNet-->>FittingNet: Initialize with pre-trained weights
    end
    Model->>Trainer: Initialization complete
    Trainer->>User: Fine-tuning setup complete
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 913141a and 4b58c91.

Files selected for processing (2)
  • deepmd/pt/entrypoints/main.py (2 hunks)
  • source/tests/pt/test_dp_show.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • source/tests/pt/test_dp_show.py
Additional context used
Ruff
deepmd/pt/entrypoints/main.py

117-117: Local variable f is assigned to but never used

Remove assignment to unused variable f

(F841)


382-385: Use ternary operator FLAGS = parse_args(args=args) if not isinstance(args, argparse.Namespace) else args instead of if-else-block

Replace if-else-block with FLAGS = parse_args(args=args) if not isinstance(args, argparse.Namespace) else args

(SIM108)

Additional comments not posted (2)
deepmd/pt/entrypoints/main.py (2)

232-235: Validation for model name in multitask mode is correctly implemented.

The addition of this validation is important to prevent the use of 'RANDOM' as a model name in multitask mode, which could lead to configuration conflicts. The implementation using an assert statement is appropriate here.


344-348: Properly updated model branches list to include 'RANDOM'.

This update ensures that users are aware of the 'RANDOM' option for initializing a fitting net, enhancing the flexibility of model configuration. The log message is clear and informative.


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.

Copy link

codecov bot commented Jun 26, 2024

Codecov Report

Attention: Patch coverage is 88.88889% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.87%. Comparing base (4e72a97) to head (4b58c91).
Report is 113 commits behind head on devel.

Files with missing lines Patch % Lines
deepmd/pt/entrypoints/main.py 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #3914      +/-   ##
==========================================
- Coverage   82.87%   82.87%   -0.01%     
==========================================
  Files         519      519              
  Lines       50666    50670       +4     
  Branches     3015     3015              
==========================================
+ Hits        41990    41993       +3     
- Misses       7739     7740       +1     
  Partials      937      937              

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

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

deepmd/pt/utils/finetune.py Show resolved Hide resolved
deepmd/pt/utils/finetune.py Show resolved Hide resolved
@iProzd iProzd added the Test CUDA Trigger test CUDA workflow label Jun 27, 2024
@github-actions github-actions bot removed the Test CUDA Trigger test CUDA workflow label Jun 27, 2024
@iProzd iProzd enabled auto-merge June 28, 2024 14:53
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 (2)
deepmd/pt/entrypoints/main.py (2)

Line range hint 117-117: Remove unused variable f.

The variable f is declared but not used, which could lead to confusion and is not efficient.

- with h5py.File(stat_file_path_single, "w") as f:
+ with h5py.File(stat_file_path_single, "w") as _:

Line range hint 382-385: Simplify argument parsing using a ternary operator.

Replacing the if-else block with a ternary operator simplifies the code and enhances readability.

- if not isinstance(args, argparse.Namespace):
-     FLAGS = parse_args(args=args)
- else:
-     FLAGS = args
+ FLAGS = parse_args(args=args) if not isinstance(args, argparse.Namespace) else args

@iProzd iProzd added this pull request to the merge queue Jun 28, 2024
Merged via the queue into deepmodeling:devel with commit cf8bd2a Jun 28, 2024
60 checks passed
@iProzd iProzd deleted the add_random_fit_finetune branch June 28, 2024 17:17
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
Support fine-tuning from random fitting in single-from-single
fine-tuning.

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

- **New Features**
- Introduced the ability to randomly initialize fitting nets for
fine-tuning by setting the model branch to "RANDOM".
- Added support for "RANDOM" model branches in multitask pre-trained
model scenarios.

- **Documentation**
- Updated fine-tuning documentation to include details on handling
fitting net weights and using the `--model-branch RANDOM` parameter.

- **Tests**
- Added tests to verify the random initialization of fitting nets and
parameter closeness checks during fine-tuning.
  - Updated test cases to include "RANDOM" model branches in the output.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Support fine-tuning from a randomly initialized fitting net.
4 participants