deepmodeling / deepmd-kit

A deep learning package for many-body potential energy representation and molecular dynamics
https://docs.deepmodeling.com/projects/deepmd/
GNU Lesser General Public License v3.0
1.46k stars 504 forks source link

feat(pt/tf/dp): support econf type embedding #3781

Closed iProzd closed 4 months ago

iProzd commented 4 months ago

Summary by CodeRabbit

These updates provide more flexibility and control over electronic configuration type embedding, enhancing the model's configurability and performance.

coderabbitai[bot] commented 4 months ago

[!WARNING]

Rate Limit Exceeded

@iProzd has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 3 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 05132182bcc9dbb73a81622d66e5b726cdcbe594 and 543b050cb2f172e983f1517fcdd601c55b686385.

Walkthrough

This update introduces support for electronic configuration type embedding (econf_tebd) across various modules in the deepmd library. Key changes include adding use_econf_tebd and type_map parameters to constructors, modifying serialization methods to handle these new parameters, and updating logic to conditionally compute embeddings based on use_econf_tebd. These enhancements allow for more flexible and detailed atom type embeddings, improving the model's capability to handle diverse atomic configurations.

Changes

File Path Change Summary
deepmd/dpmodel/descriptor/dpa2.py Added use_econf_tebd and type_map parameters to the constructor and serialization methods.
deepmd/pt/model/descriptor/dpa1.py Introduced use_econf_tebd and type_map parameters to the constructor and updated the TypeEmbedNet instantiation and serialization methods.
deepmd/dpmodel/utils/type_embed.py Added use_econf_tebd and type_map parameters to TypeEmbedNet class and updated logic for embedding computation and serialization.
deepmd/pt/model/model/__init__.py Added conditions to handle type_map when use_econf_tebd is True in get_zbl_model and get_standard_model functions.
deepmd/pt/model/network/network.py Enhanced TypeEmbedNet and TypeEmbedNetConsistent classes to include use_econf_tebd and type_map parameters, updating initialization and serialization logic.
deepmd/tf/descriptor/se_atten.py Updated DescrptDPA1Compat class to include use_econf_tebd and type_map parameters, and modified serialization methods.
deepmd/tf/model/model.py Added logic to handle use_econf_tebd and type_map in the Model class constructor.
deepmd/tf/model/pairwise_dprc.py Updated PairwiseDPRC class constructor to handle use_econf_tebd in type_embedding.
deepmd/tf/utils/type_embed.py Enhanced TypeEmbedNet class to include use_econf_tebd and type_map parameters, updating initialization, build, and serialization methods.
deepmd/utils/argcheck.py Added use_econf_tebd argument to type_embedding_args, descrpt_se_atten_args, and descrpt_dpa2_args functions.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 94.80519% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 82.50%. Comparing base (2bf0769) to head (543b050).

Files Patch % Lines
deepmd/pt/model/model/__init__.py 50.00% 2 Missing :warning:
deepmd/tf/model/model.py 50.00% 1 Missing :warning:
deepmd/tf/model/pairwise_dprc.py 50.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## devel #3781 +/- ## ========================================== + Coverage 82.49% 82.50% +0.01% ========================================== Files 515 515 Lines 48642 48712 +70 Branches 2980 2980 ========================================== + Hits 40126 40192 +66 - Misses 7605 7609 +4 Partials 911 911 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.