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

docs: cleanup out-of-date doc_only_tf_supported in arguments #3896

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Jun 23, 2024

Summary by CodeRabbit

  • Refactor
    • Simplified internal argument checks by removing deprecated doc_only_tf_supported references across several functions to enhance maintainability.

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

coderabbitai bot commented Jun 23, 2024

Walkthrough

Walkthrough

The changes focus on removing doc_only_tf_supported from various argument declarations in the argcheck.py file within the deepmd/utils directory. This streamlining suggests that previously conditionally supported TensorFlow-specific documentation elements are no longer needed, possibly indicating a shift towards a more framework-agnostic documentation or deprecated feature.

Changes

File Path Change Summary
deepmd/utils/argcheck.py Removed doc_only_tf_supported from several argument declarations, including within the descrpt_se_atten_common_args, model_args, and fitting_args_plugin.register functions.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a09738c and e4d1958.

Files selected for processing (1)
  • deepmd/utils/argcheck.py (6 hunks)
Additional context used
Ruff
deepmd/utils/argcheck.py

75-75: No explicit stacklevel keyword argument found (B028)


1167-1167: Local variable link_lf is assigned to but never used (F841)

Remove assignment to unused variable link_lf


1168-1168: Local variable link_se_e2_a is assigned to but never used (F841)

Remove assignment to unused variable link_se_e2_a


1169-1169: Local variable link_se_e2_r is assigned to but never used (F841)

Remove assignment to unused variable link_se_e2_r


1170-1170: Local variable link_se_e3 is assigned to but never used (F841)

Remove assignment to unused variable link_se_e3


1171-1171: Local variable link_se_a_tpe is assigned to but never used (F841)

Remove assignment to unused variable link_se_a_tpe


1172-1172: Local variable link_hybrid is assigned to but never used (F841)

Remove assignment to unused variable link_hybrid


1173-1173: Local variable link_se_atten is assigned to but never used (F841)

Remove assignment to unused variable link_se_atten


1174-1174: Local variable link_se_atten_v2 is assigned to but never used (F841)

Remove assignment to unused variable link_se_atten_v2


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.

@njzjz njzjz requested review from iProzd and anyangml June 23, 2024 15: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/utils/argcheck.py (2)

Line range hint 75-75: Specify stacklevel in warning calls for clearer debugging.

The warnings.warn function is called without specifying the stacklevel. Adding stacklevel=2 would help in tracing the warning back to the caller's location in the stack, making debugging easier.

- warnings.warn(f"{key} has been removed and takes no effect.", FutureWarning)
+ warnings.warn(f"{key} has been removed and takes no effect.", FutureWarning, stacklevel=2)

Line range hint 1167-1174: Remove unused local variables.

Several local variables (link_lf, link_se_e2_a, link_se_e2_r, link_se_e3, link_se_a_tpe, link_hybrid, link_se_atten, link_se_atten_v2) are defined but never used in the code. Removing these can clean up the code and reduce confusion.

- link_lf = make_link("loc_frame", "model/descriptor[loc_frame]")
- link_se_e2_a = make_link("se_e2_a", "model/descriptor[se_e2_a]")
- link_se_e2_r = make_link("se_e2_r", "model/descriptor[se_e2_r]")
- link_se_e3 = make_link("se_e3", "model/descriptor[se_e3]")
- link_se_a_tpe = make_link("se_a_tpe", "model/descriptor[se_a_tpe]")
- link_hybrid = make_link("hybrid", "model/descriptor[hybrid]")
- link_se_atten = make_link("se_atten", "model/descriptor[se_atten]")
- link_se_atten_v2 = make_link("se_atten_v2", "model/descriptor[se_atten_v2]")

Copy link

codecov bot commented Jun 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.72%. Comparing base (b6f0fa3) to head (e4d1958).
Report is 120 commits behind head on devel.

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #3896      +/-   ##
==========================================
- Coverage   82.74%   82.72%   -0.03%     
==========================================
  Files         519      519              
  Lines       50491    50511      +20     
  Branches     3015     3015              
==========================================
+ Hits        41781    41787       +6     
- Misses       7773     7788      +15     
+ Partials      937      936       -1     

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

@njzjz njzjz changed the title docs: cleanup doc_only_tf_supportedtu in arguments docs: cleanup out-of-date doc_only_tf_supportedtu in arguments Jun 23, 2024
@njzjz njzjz changed the title docs: cleanup out-of-date doc_only_tf_supportedtu in arguments docs: cleanup out-of-date doc_only_tf_supported in arguments Jun 23, 2024
Copy link
Collaborator

@anyangml anyangml left a comment

Choose a reason for hiding this comment

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

LGTM

@iProzd iProzd added this pull request to the merge queue Jun 24, 2024
Merged via the queue into deepmodeling:devel with commit bbe5c4b Jun 24, 2024
60 checks passed
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
…eling#3896)

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

## Summary by CodeRabbit

- **Refactor**
- Simplified internal argument checks by removing deprecated
`doc_only_tf_supported` references across several functions to enhance
maintainability.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
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.

3 participants