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.41k stars 486 forks source link

ci(wheel): build PT OPs #3894

Closed njzjz closed 1 week ago

njzjz commented 1 week ago

Build PT OPs for our wheels (against the CPU version of PT but work with the GPU version). Add PT to the build dependencies if it is not found. Bump MPICH to the latest version. Update documentation to address that PT support for LAMMPS and i-PI is not included.

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago
Walkthrough ## Walkthrough This update introduces PyTorch support to the backend, dynamically adjusting the build and runtime requirements based on the availability of PyTorch. Key functions now include checks for PyTorch, and new functionalities are added to handle PyTorch-specific requirements and versions. The documentation and configuration files have been updated to reflect these changes, ensuring smooth integration with existing PyTorch and TensorFlow dependencies. ## Changes | File(s) | Change Summary | |-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| | `backend/dp_backend.py` | Imported `find_pytorch`, and updated `get_requires_for_build_wheel` and `get_requires_for_build_editable` to include `find_pytorch()`. | | `backend/dynamic_metadata.py` | Imported `get_pt_requirement`, and modified `dynamic_metadata` function to handle PyTorch version. | | `backend/find_pytorch.py` | Updated `find_pytorch` to return PyTorch path and requirements. Added `get_pt_requirement` and `get_pt_version` functions. | | `backend/find_tensorflow.py` | Updated `get_tf_version` to accept an optional path parameter. | | `backend/read_env.py` | Imported `get_pt_version`, updated `get_argument_from_env` and `set_scikit_build_env` for PyTorch version handling. | | `doc/install/easy-install.md` | Removed macOS arm64 note and added warning about TensorFlow backend support with LAMMPS and i-PI when installing from pip. | | `pyproject.toml` | Updated dependency versions, test configurations, and build settings. Included PyTorch in test extras and added PyTorch-related environment variables. | | `source/api_cc/CMakeLists.txt` | Introduced a condition that checks for `BUILD_PY_IF` before linking libraries and setting compile definitions when `ENABLE_PYTORCH` is enabled. |

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 4c38fad9e139fa48b72b764ffa2eec9422612ba2 and 896e99588c04715e8a343e9622d40c576f438444.
Files selected for processing (3) * backend/find_pytorch.py (4 hunks) * backend/find_tensorflow.py (1 hunks) * pyproject.toml (2 hunks)
Files skipped from review as they are similar to previous changes (1) * pyproject.toml
Additional context used
Ruff
backend/find_tensorflow.py
105-105: Within an `except` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling (B904)
--- 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.` - `@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](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 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.74%. Comparing base (b6f0fa3) to head (896e995).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## devel #3894 +/- ## ======================================= Coverage 82.74% 82.74% ======================================= Files 519 519 Lines 50491 50491 Branches 3015 3015 ======================================= Hits 41781 41781 Misses 7773 7773 Partials 937 937 ```

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