deepmodeling / dpgen2

2nd generation of the Deep Potential GENerator
https://docs.deepmodeling.com/projects/dpgen2/
GNU Lesser General Public License v3.0
33 stars 26 forks source link

Support parallelization of conf filter #268

Closed zjgemi closed 1 month ago

zjgemi commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes involve modifications to several classes across multiple files, primarily focusing on enhancing the configuration filtering process. The `TrajRenderLammps` class's `get_confs` method has been simplified for efficiency. The `ConfFilter` and `ConfFilters` classes have been updated to support batch processing of configurations, introducing a new `batched_check` method. Additionally, the distance filters have been enhanced to allow parallel processing through a `max_workers` parameter. New filter classes have been added in the tests, improving the testing framework to align with the updated filtering logic. ## Changes | File Path | Change Summary | |------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `dpgen2/exploration/render/traj_render_lammps.py` | Simplified `get_confs` method in `TrajRenderLammps` class; corrected indentation for `ss = ss.sub_system(id_selected[ii])`. | | `dpgen2/exploration/selector/conf_filter.py` | Added `batched_check` method to `ConfFilter` class; modified `check` method in `ConfFilters` class to accept `dpdata.MultiSystems` instead of a single `dpdata.System`. | | `dpgen2/exploration/selector/distance_conf_filter.py` | Added `max_workers` parameter to constructors of `DistanceConfFilter`, `BoxSkewnessConfFilter`, and `BoxLengthFilter` classes; added `batched_check` methods to each class for concurrent processing; updated `args` methods for documentation. | | `tests/exploration/test_conf_filter.py` | Modified `FooFilter` class's `check` method; added `BarFilter` and `BazFilter` classes with new `check` methods; removed `faked_filter` class; updated test cases to reflect new filter logic and ensure correct frame preservation. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant TrajRenderLammps participant ConfFilters participant ConfFilter participant DistanceConfFilter User->>TrajRenderLammps: request get_confs TrajRenderLammps->>ConfFilters: call check(ms) ConfFilters->>ConfFilter: call batched_check(frames) ConfFilter-->>ConfFilters: return validity list ConfFilters-->>TrajRenderLammps: return valid configurations TrajRenderLammps-->>User: return configurations ``` ```mermaid sequenceDiagram participant User participant DistanceConfFilter User->>DistanceConfFilter: request batched_check(frames) DistanceConfFilter->>ProcessPoolExecutor: execute checks ProcessPoolExecutor-->>DistanceConfFilter: return results DistanceConfFilter-->>User: return valid frames ```

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 , 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 69.76744% with 13 lines in your changes missing coverage. Please review.

Project coverage is 83.62%. Comparing base (08d8d6e) to head (a20cea0). Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
...pgen2/exploration/selector/distance_conf_filter.py 52.00% 12 Missing :warning:
dpgen2/exploration/render/traj_render_lammps.py 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #268 +/- ## ========================================== - Coverage 83.65% 83.62% -0.04% ========================================== Files 104 104 Lines 6028 6057 +29 ========================================== + Hits 5043 5065 +22 - Misses 985 992 +7 ```

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