Feat: output logs on freezing models

[caic99]

dp --pt freeze does not output whether the operation finishes successfully. This PR adds a log message on it.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a new log statement in the freeze function of the deepmd/pt/entrypoints/main.py file. This log statement confirms the successful saving of the frozen model and specifies the output location. The change aims to enhance the logging capabilities related to model saving operations.

Changes

Files	Change Summary
deepmd/pt/entrypoints/main.py	Added a log statement to the freeze function indicating the output path of the saved frozen model.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FreezeFunction
    participant Logger

    User->>FreezeFunction: Call freeze()
    FreezeFunction->>FreezeFunction: Save model
    FreezeFunction->>Logger: Log "Saved frozen model to {FLAGS.output}"
    Logger-->>FreezeFunction: Confirmation logged
    FreezeFunction-->>User: Model frozen successfully

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

deepmd/pt/entrypoints/main.py (1)

357-357: LGTM! Consider adding error handling.

The added log statement effectively fulfills the PR objective by outputting the path where the frozen model is saved. This enhances the user experience by providing clear feedback on the operation's success.

Consider wrapping the model saving operation in a try-except block to handle potential I/O errors and provide more informative error messages. For example:

try:
    torch.jit.save(
        model,
        FLAGS.output,
        extra_files,
    )
    log.info(f"Saved frozen model to {FLAGS.output}")
except IOError as e:
    log.error(f"Failed to save frozen model to {FLAGS.output}: {str(e)}")
    raise

This enhancement would provide more detailed information if the save operation fails, aiding in troubleshooting.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0b3f860 and d77874e.

📒 Files selected for processing (1)

• deepmd/pt/entrypoints/main.py (1 hunks)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.45%. Comparing base (0b3f860) to head (d77874e).
Report is 193 commits behind head on devel.

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #4165      +/-   ##
==========================================
- Coverage   83.45%   83.45%   -0.01%     
==========================================
  Files         537      537              
  Lines       52146    52147       +1     
  Branches     3046     3046              
==========================================
  Hits        43521    43521              
  Misses       7677     7677              
- Partials      948      949       +1     

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