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

chore(tf): filter TF deprecation warnings #4199

Merged
merged 1 commit into from
Oct 13, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Oct 10, 2024

Fix #2367. Fix #3039.

These warnings are not true - these deprecated APIs have existed for several years and never been removed.

Summary by CodeRabbit

  • New Features

    • Enhanced logging capabilities for TensorFlow warnings.
    • Introduced a new filter to manage specific warning messages from the TensorFlow logger.
  • Bug Fixes

    • Improved the configuration sequence for the TensorFlow logger to ensure proper functionality.

Fix deepmodeling#2367. Fix deepmodeling#3069.

These warnings are not true - these deprecated APIs have existed for several years and never been removed.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

📝 Walkthrough

Walkthrough

The changes in the deepmd/tf/env.py file enhance logging capabilities related to TensorFlow warnings. A new TFWarningFilter class is introduced to filter specific warning messages from the TensorFlow logger. The logger configuration is updated to apply this filter before disabling TensorFlow v2 behavior, ensuring that the logging setup occurs prior to any TensorFlow operations. These modifications aim to streamline the logging process without impacting the existing functionality of the code.

Changes

File Change Summary
deepmd/tf/env.py Added TFWarningFilter class to filter TensorFlow warnings. Updated logger configuration to apply the filter before disabling TensorFlow v2 behavior. Introduced FILTER_MSGS list for specific warning messages.

Assessment against linked issues

Objective Addressed Explanation
Improve handling of TensorFlow warnings (2367)
Ensure that warnings are filtered out from logs (2367)
Address installation issues with deepmd pair style (3069) Changes do not relate to installation issues.
Clarify reasons for TensorFlow warnings (2367) The implementation does not provide explanations for existing warnings.
Enhance logging without altering core functionality (2367)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3939786 and 3101e8e.

📒 Files selected for processing (1)
  • deepmd/tf/env.py (2 hunks)
🧰 Additional context used
🔇 Additional comments (4)
deepmd/tf/env.py (4)

5-5: Import of the logging module is appropriate.

The logging module is correctly imported to enable logging functionalities used in the subsequent code.


80-83: FILTER_MSGS effectively specifies the warning messages to filter.

The list FILTER_MSGS accurately contains the specific warning messages intended to be filtered out from the TensorFlow logger.


86-89: TFWarningFilter class properly filters the specified warnings.

The custom TFWarningFilter class correctly overrides the filter method to exclude log records containing any messages from FILTER_MSGS.


98-99: Logger filter is applied before disabling TensorFlow v2 behavior.

Applying the logger filter before calling tf.disable_v2_behavior() ensures that any deprecation warnings are appropriately filtered as intended.


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

codecov bot commented Oct 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.50%. Comparing base (3939786) to head (3101e8e).
Report is 4 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4199      +/-   ##
==========================================
- Coverage   83.50%   83.50%   -0.01%     
==========================================
  Files         539      539              
  Lines       52339    52342       +3     
  Branches     3047     3047              
==========================================
+ Hits        43708    43709       +1     
  Misses       7685     7685              
- Partials      946      948       +2     

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

@njzjz njzjz requested review from iProzd and wanghan-iapcm October 10, 2024 08:11
@njzjz njzjz requested a review from iProzd October 13, 2024 03:07
@iProzd iProzd enabled auto-merge October 13, 2024 04:58
@iProzd iProzd added this pull request to the merge queue Oct 13, 2024
Merged via the queue into deepmodeling:devel with commit c10bc3c Oct 13, 2024
60 checks passed
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.

dp freeze and dp compress: warning A series of warnings often appear while using DeePMD-kit
3 participants