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: fix spelling PRECISON -> PRECISION #4508

Merged
merged 1 commit into from
Dec 26, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Dec 25, 2024

Luckily, this variable has never been used otherwhere.

Summary by CodeRabbit

  • Bug Fixes

    • Corrected the spelling of RESERVED_PRECISON_DICT to RESERVED_PRECISION_DICT across multiple files to ensure consistency and prevent potential runtime errors.
  • Documentation

    • Updated comments and documentation to reflect the corrected variable name, enhancing clarity without altering functionality.

Luckily, this variable has never been used otherwhere.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 5 out of 17 changed files in this pull request and generated no comments.

Files not reviewed (12)
  • deepmd/pt/model/model/make_model.py: Evaluated as low risk
  • deepmd/pd/infer/deep_eval.py: Evaluated as low risk
  • deepmd/pt/infer/deep_eval.py: Evaluated as low risk
  • deepmd/dpmodel/model/make_model.py: Evaluated as low risk
  • deepmd/pd/model/descriptor/se_t_tebd.py: Evaluated as low risk
  • deepmd/pd/model/model/make_model.py: Evaluated as low risk
  • deepmd/pt/model/descriptor/se_t.py: Evaluated as low risk
  • deepmd/pt/model/descriptor/se_a.py: Evaluated as low risk
  • deepmd/pd/model/descriptor/se_a.py: Evaluated as low risk
  • deepmd/pt/model/descriptor/se_t_tebd.py: Evaluated as low risk
  • deepmd/pt/model/descriptor/se_r.py: Evaluated as low risk
  • deepmd/pd/model/descriptor/dpa1.py: Evaluated as low risk
Copy link
Contributor

coderabbitai bot commented Dec 25, 2024

📝 Walkthrough

Walkthrough

This pull request focuses on correcting a spelling error in the variable name RESERVED_PRECISON_DICT to RESERVED_PRECISION_DICT across multiple files in the DeepMD project. The changes span various modules including common.py, make_model.py, deep_eval.py, descriptor files, and utility environment files. The correction ensures consistent naming of the precision dictionary throughout the codebase, maintaining the existing functionality while improving code readability and preventing potential naming-related errors.

Changes

File Path Change Summary
deepmd/dpmodel/common.py Renamed RESERVED_PRECISON_DICT to RESERVED_PRECISION_DICT
deepmd/dpmodel/model/make_model.py Updated variable name references to RESERVED_PRECISION_DICT
deepmd/pd/infer/deep_eval.py Corrected dictionary key name
deepmd/pd/model/descriptor/* (dpa1.py, se_a.py, se_t_tebd.py) Updated import and usage of RESERVED_PRECISION_DICT
deepmd/pd/model/model/make_model.py Corrected variable name in import and initialization
deepmd/pd/utils/env.py Renamed variable and updated __all__ list
deepmd/pt/infer/deep_eval.py Updated variable name references
deepmd/pt/model/descriptor/* (multiple files) Corrected import and usage of RESERVED_PRECISION_DICT
deepmd/pt/model/model/make_model.py Updated variable name in initialization
deepmd/pt/utils/env.py Renamed variable and updated __all__ list

Possibly related PRs

Suggested Labels

Python, Docs

Suggested Reviewers

  • wanghan-iapcm

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between beeb3d9 and 55b41bd.

📒 Files selected for processing (17)
  • deepmd/dpmodel/common.py (4 hunks)
  • deepmd/dpmodel/model/make_model.py (5 hunks)
  • deepmd/pd/infer/deep_eval.py (3 hunks)
  • deepmd/pd/model/descriptor/dpa1.py (2 hunks)
  • deepmd/pd/model/descriptor/se_a.py (2 hunks)
  • deepmd/pd/model/descriptor/se_t_tebd.py (2 hunks)
  • deepmd/pd/model/model/make_model.py (2 hunks)
  • deepmd/pd/utils/env.py (3 hunks)
  • deepmd/pt/infer/deep_eval.py (4 hunks)
  • deepmd/pt/model/descriptor/dpa1.py (2 hunks)
  • deepmd/pt/model/descriptor/se_a.py (2 hunks)
  • deepmd/pt/model/descriptor/se_atten_v2.py (2 hunks)
  • deepmd/pt/model/descriptor/se_r.py (2 hunks)
  • deepmd/pt/model/descriptor/se_t.py (2 hunks)
  • deepmd/pt/model/descriptor/se_t_tebd.py (2 hunks)
  • deepmd/pt/model/model/make_model.py (2 hunks)
  • deepmd/pt/utils/env.py (3 hunks)
✅ Files skipped from review due to trivial changes (16)
  • deepmd/pd/model/descriptor/dpa1.py
  • deepmd/pd/model/model/make_model.py
  • deepmd/pt/model/descriptor/dpa1.py
  • deepmd/pd/model/descriptor/se_a.py
  • deepmd/dpmodel/common.py
  • deepmd/pt/model/descriptor/se_t_tebd.py
  • deepmd/pd/utils/env.py
  • deepmd/pd/model/descriptor/se_t_tebd.py
  • deepmd/pd/infer/deep_eval.py
  • deepmd/pt/model/descriptor/se_r.py
  • deepmd/pt/model/model/make_model.py
  • deepmd/pt/model/descriptor/se_atten_v2.py
  • deepmd/pt/model/descriptor/se_a.py
  • deepmd/pt/infer/deep_eval.py
  • deepmd/pt/model/descriptor/se_t.py
  • deepmd/dpmodel/model/make_model.py
🔇 Additional comments (3)
deepmd/pt/utils/env.py (3)

57-57: Spelling fix looks good!

Correcting the spelling of the variable here to RESERVED_PRECISION_DICT improves clarity and consistency. No functional changes are introduced.


66-66: Consistency maintained with the updated dictionary name.

This assertion ensures type safety by verifying that every value in PRECISION_DICT is mapped in RESERVED_PRECISION_DICT. The renaming maintains consistency.


90-90: Export list updated successfully.

Adding RESERVED_PRECISION_DICT to __all__ helps make it part of the module’s public interface.

Run this script to confirm there are no remaining references to the old spelling:

✅ Verification successful

No misspelled references found, variable is used consistently

The search results confirm that:

  1. There are no instances of the misspelled RESERVED_PRECISON_DICT in the codebase
  2. The correctly spelled RESERVED_PRECISION_DICT is used consistently across multiple modules in the PyTorch (pt), Paddle (pd), and base implementations
  3. The variable is properly exported in deepmd/pt/utils/env.py
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Searching for any leftover references to the misspelled variable across the entire codebase
rg -A 3 'RESERVED_PRECISON_DICT'

Length of output: 32


Script:

#!/bin/bash
# Let's verify both the old and new spellings to ensure the change was made correctly
echo "Checking for RESERVED_PRECISION_DICT (correct spelling):"
rg -A 3 'RESERVED_PRECISION_DICT'

echo -e "\nChecking files containing precision-related constants:"
fd -e py | xargs grep -l "precision" || true

Length of output: 18210


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 Dec 25, 2024

Codecov Report

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

Project coverage is 84.58%. Comparing base (beeb3d9) to head (55b41bd).
Report is 3 commits behind head on devel.

Files with missing lines Patch % Lines
deepmd/pd/infer/deep_eval.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #4508      +/-   ##
==========================================
- Coverage   84.59%   84.58%   -0.01%     
==========================================
  Files         675      675              
  Lines       63574    63575       +1     
  Branches     3490     3486       -4     
==========================================
  Hits        53778    53778              
- Misses       8670     8671       +1     
  Partials     1126     1126              

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

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Dec 26, 2024
Merged via the queue into deepmodeling:devel with commit 5788f79 Dec 26, 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.

2 participants