Skip to content

fix(tf): fix argcheck when compressing a model converted from other backends#4331

Merged
wanghan-iapcm merged 1 commit intodeepmodeling:develfrom
njzjz:fix-tf-compress-other-backnds
Nov 11, 2024
Merged

fix(tf): fix argcheck when compressing a model converted from other backends#4331
wanghan-iapcm merged 1 commit intodeepmodeling:develfrom
njzjz:fix-tf-compress-other-backnds

Conversation

@njzjz
Copy link
Member

@njzjz njzjz commented Nov 10, 2024

When the model is converted from other backends, the input script only contains the model section. This PR sets the default for any necessary argument.

Summary by CodeRabbit

  • New Features

    • Enhanced the data structure for model compression by adding default keys for training steps and learning rate.
  • Bug Fixes

    • Improved error handling with more informative runtime exceptions for missing training scripts.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 10, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request modify the compress function within the deepmd/tf/entrypoints/compress.py file. Two new entries are added to the jdata dictionary to ensure the presence of default values for training steps and learning rate. Additionally, the error handling logic is enhanced to provide more informative runtime exceptions related to missing training scripts, while preserving existing error messages and conditions.

Changes

File Path Change Summary
deepmd/tf/entrypoints/compress.py Added default entries for training and learning_rate in jdata. Updated error handling for missing training scripts.

Suggested labels

Python

Suggested reviewers

  • wanghan-iapcm
  • iProzd

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/tf/entrypoints/compress.py (1)

150-151: LGTM with suggestions for improvement.

The fix correctly addresses the issue with converted models by providing default values for required normalization arguments. The placement and default values are appropriate.

Consider these improvements:

  1. Add a comment explaining why these specific defaults were chosen
  2. Add validation to warn users when these defaults are used, as it might indicate unexpected model configuration
+    # Default values for models converted from other backends that only include 'model' section
+    if "training" not in jdata:
+        log.warning("No training configuration found. Using defaults for converted model.")
     jdata.setdefault("training", {"numb_steps": 0})
+    if "learning_rate" not in jdata:
+        log.warning("No learning rate configuration found. Using defaults for converted model.")
     jdata.setdefault("learning_rate", {})
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 023bb9c and eb54e69.

📒 Files selected for processing (1)
  • deepmd/tf/entrypoints/compress.py (1 hunks)
🔇 Additional comments (1)
deepmd/tf/entrypoints/compress.py (1)

150-154: Verify normalization behavior with default values.

The code adds default values before normalization. Let's ensure the normalize function properly handles these defaults.

✅ Verification successful

Based on the search results, I found that the normalize function is implemented in deepmd/utils/argcheck.py and is used to validate and normalize input arguments. The code shows that the normalize function properly handles empty dictionaries through the base Argument class. Additionally, looking at the compression code in deepmd/tf/entrypoints/compress.py, we can see that:

  1. Empty dictionaries are explicitly set as defaults for both "training" and "learning_rate"
  2. The normalize function is called after setting these defaults
  3. The normalize function is designed to handle these default values through argument validation

Default values are properly handled by the normalization step.

The code follows a pattern of setting defaults first, then normalizing the input through a robust argument validation system. This is a safe approach that ensures proper initialization of configuration parameters.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for normalize function implementation to verify handling of empty learning_rate
ast-grep --pattern 'def normalize($$$)' 

# Search for any validation of training or learning_rate fields
rg -A 5 'training.*numb_steps|learning_rate' --type python

Length of output: 133


Script:

#!/bin/bash
# Search for normalize function implementation without file type restriction
rg -A 10 "def normalize"

# Search for validation patterns without file type restriction
rg -A 5 "training.*numb_steps|learning_rate"

# Find all Python files that might contain normalize function
fd "\.py$" --exec grep -l "normalize"

Length of output: 161722

@codecov
Copy link

codecov bot commented Nov 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.54%. Comparing base (023bb9c) to head (eb54e69).
Report is 124 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4331      +/-   ##
==========================================
- Coverage   84.58%   84.54%   -0.05%     
==========================================
  Files         571      571              
  Lines       53180    53182       +2     
  Branches     3059     3059              
==========================================
- Hits        44981    44961      -20     
- Misses       7237     7258      +21     
- Partials      962      963       +1     

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

@njzjz njzjz changed the title fix(tf): fix normalize when compressing a model converted from other backends fix(tf): fix argcheck when compressing a model converted from other backends Nov 10, 2024
@njzjz njzjz requested a review from wanghan-iapcm November 10, 2024 20:26
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Nov 11, 2024
Merged via the queue into deepmodeling:devel with commit 02a3048 Nov 11, 2024
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