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

fix: add mendeleev to dependencies; remove dpdata; remove catching ImportError #3878

Merged
merged 5 commits into from
Jun 14, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Jun 14, 2024

Fix #3743.

Summary by CodeRabbit

  • Chores
    • Consolidated imports and removed redundant exception handling for dpdata and mendeleev.
    • Updated dependencies in pyproject.toml to include mendeleev in the main section and update packages for testing and documentation.

Fix deepmodeling#3743. This will give users more clear error message than `NameError`.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz requested a review from wanghan-iapcm June 14, 2024 01:47
Copy link
Contributor

coderabbitai bot commented Jun 14, 2024

Walkthrough

Walkthrough

The changes aim to simplify the dependency management and import handling for dpdata and mendeleev within the project by removing redundant try-except blocks, consolidating the imports, and adjusting the package dependencies in pyproject.toml. This addresses a specific test failure and improves the overall test and documentation setup.

Changes

File Change Summary
deepmd/utils/econf_embd.py Removed redundant try-except block; consolidated imports.
pyproject.toml Moved mendeleev to dependencies section; adjusted test and docs sections dependencies.
source/tests/common/test_econf_embd.py Removed import and existence checks for mendeleev; simplified test setup.

Sequence Diagram(s)

No sequence diagrams are necessary as the changes are mainly around import handling and dependency management.

Assessment against linked issues

Objective Addressed Explanation
Simplify import handling for mendeleev and ensure it's in the main dependencies section (#3743).
Fix the tests.common.test_econf_embd.TestEConfEmbd.test_fe by ensuring mendeleev is correctly imported (#3743).

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7ec5755 and a41dcb6.

Files selected for processing (3)
  • deepmd/utils/econf_embd.py (2 hunks)
  • pyproject.toml (2 hunks)
  • source/tests/common/test_econf_embd.py (1 hunks)
Files skipped from review due to trivial changes (1)
  • source/tests/common/test_econf_embd.py
Files skipped from review as they are similar to previous changes (1)
  • deepmd/utils/econf_embd.py
Additional comments not posted (3)
pyproject.toml (3)

50-50: Moving mendeleev from dev-dependencies to dependencies ensures it is always available, preventing runtime errors.


50-50: Removal of mendeleev from dev-dependencies is consistent with its addition to dependencies.


50-50: Update to sphinx>=3.1.1 in the docs section is approved. Please verify compatibility with existing documentation setups.


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 linked an issue Jun 14, 2024 that may be closed by this pull request
Copy link
Collaborator

@wanghan-iapcm wanghan-iapcm left a comment

Choose a reason for hiding this comment

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

shall we add dpdata and mendeleev to dependencies?

Copy link

codecov bot commented Jun 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.70%. Comparing base (c644314) to head (a41dcb6).
Report is 116 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3878   +/-   ##
=======================================
  Coverage   82.70%   82.70%           
=======================================
  Files         517      517           
  Lines       50141    50137    -4     
  Branches     2984     2985    +1     
=======================================
- Hits        41469    41467    -2     
+ Misses       7762     7760    -2     
  Partials      910      910           

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

@njzjz
Copy link
Member Author

njzjz commented Jun 14, 2024

shall we add dpdata and mendeleev to dependencies?

I don't find the meaning of using dpdata - the element table has already been hard-coded in econf_embd.py

"Og" : [2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2],

@wanghan-iapcm
Copy link
Collaborator

yes, please remove the import of dpdata.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz requested a review from wanghan-iapcm June 14, 2024 04:53
@njzjz njzjz changed the title fix: don't catch ImportError for mendeleev and dpdata fix: add mendeleev to dependencies; remove dpdata; remove catching ImportError Jun 14, 2024
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Jun 14, 2024
Merged via the queue into deepmodeling:devel with commit d23f7ae Jun 14, 2024
60 checks passed
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
…portError (deepmodeling#3878)

Fix deepmodeling#3743.

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

- **Chores**
- Consolidated imports and removed redundant exception handling for
`dpdata` and `mendeleev`.
- Updated dependencies in `pyproject.toml` to include `mendeleev` in the
main section and update packages for testing and documentation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
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.

tests.common.test_econf_embd.TestEConfEmbd.test_fe failed
2 participants