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

chore(lmp): add LAMMPS DPA-2 nopbc tests #4220

Merged
merged 5 commits into from
Oct 17, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Oct 15, 2024

Adding tests to see whether #4167 is resolved. The answer is no. Segfaults are thrown with MPI.

Summary by CodeRabbit

  • New Features
    • Introduced a new command-line argument --nopbc to modify boundary conditions in LAMMPS simulations.
  • Tests
    • Added a comprehensive suite of unit tests for the DeepMD potential in LAMMPS, covering various configurations and scenarios to ensure accuracy and reliability.

Signed-off-by: Jinzhe Zeng <[email protected]>
Signed-off-by: Jinzhe Zeng <[email protected]>
Signed-off-by: Jinzhe Zeng <[email protected]>
Signed-off-by: Jinzhe Zeng <[email protected]>
Copy link
Contributor

coderabbitai bot commented Oct 15, 2024

📝 Walkthrough

Walkthrough

The changes introduce a new command-line argument --nopbc in the run_mpi_pair_deepmd.py script, which modifies the boundary conditions for LAMMPS simulations. If specified, the boundaries are set to "f f f" (free), otherwise they remain "p p p" (periodic). Additionally, a new test file test_lammps_dpa_pt_nopbc.py has been created, containing a suite of unit tests for the DeepMD potential in LAMMPS. This file includes setup and teardown functions, LAMMPS initialization, and various test cases to validate simulation behaviors under different configurations.

Changes

File Path Change Summary
source/lmp/tests/run_mpi_pair_deepmd.py Added command-line argument --nopbc to set boundary conditions to "f f f" or "p p p".
source/lmp/tests/test_lammps_dpa_pt_nopbc.py Introduced a suite of unit tests for DeepMD in LAMMPS, including setup/teardown functions and multiple test cases. Functions added for LAMMPS initialization and various test scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script
    participant LAMMPS

    User->>Script: Run with --nopbc
    Script->>LAMMPS: Set boundary conditions to "f f f"
    Script->>LAMMPS: Execute simulation
    LAMMPS-->>Script: Return results
    Script-->>User: Display results
Loading

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>, 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 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.

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: 3

🧹 Outside diff range and nitpick comments (3)
source/lmp/tests/run_mpi_pair_deepmd.py (2)

42-45: LGTM: Boundary conditions set correctly based on --nopbc argument.

The implementation correctly uses the new --nopbc argument to set the boundary conditions. This change allows for testing both periodic and non-periodic boundary conditions, which is crucial for verifying the issues mentioned in PR #4167.

Consider adding a comment explaining the meaning of "f f f" and "p p p" for improved clarity:

if args.nopbc:
    lammps.boundary("f f f")  # Set free boundaries in all directions
else:
    lammps.boundary("p p p")  # Set periodic boundaries in all directions

Line range hint 1-67: Consider adding error handling and a test case for MPI-related issues.

While the changes implemented are correct, the PR description mentions segmentation faults when using MPI. To address this:

  1. Consider adding error handling around the MPI calls to catch and report any segmentation faults or other errors that might occur during execution.
  2. It might be beneficial to add a test case that attempts to reproduce the segmentation fault mentioned in the PR description. This could help in identifying and resolving the issue.

Here's a simple example of how you might add some basic error handling:

try:
    # Your existing MPI code here
    ...
    MPI.Finalize()
except Exception as e:
    print(f"Error occurred during MPI execution: {e}")
    # You might want to log this error or handle it in a way that's appropriate for your testing framework
    raise

Would you like assistance in implementing more robust error handling or creating a test case to reproduce the segmentation fault?

source/lmp/tests/test_lammps_dpa_pt_nopbc.py (1)

685-691: Remove commented-out code to enhance readability

The stack trace comments within the if balance_args == []: block are unnecessary and can clutter the code. If this information is important for debugging or historical context, consider moving it to a dedicated documentation file or including it in the test's docstring.

Apply this diff to clean up the code:

if balance_args == []:
-   # python:5331 terminated with signal 11 at PC=7f3e940e3806 SP=7ffd5787edc0.  Backtrace:
-   # /home/runner/work/deepmd-kit/deepmd-kit/dp_test/lib/libdeepmd_op_pt.so(+0x95806)[0x7f3e940e3806]
-   # /home/runner/work/deepmd-kit/deepmd-kit/dp_test/lib/libdeepmd_op_pt.so(+0x8f76e)[0x7f3e940dd76e]
-   # /home/runner/work/deepmd-kit/deepmd-kit/dp_test/lib/libdeepmd_op_pt.so(+0x9a38a)[0x7f3e940e838a]
-   # /home/runner/work/deepmd-kit/deepmd-kit/dp_test/lib/libdeepmd_op_pt.so(_Z9border_opRKN2at6TensorES2_S2_S2_S2_S2_S2_S2_S2_+0x8e)[0x7f3e940dda63]
-   # /home/runner/work/deepmd-kit/deepmd-kit/dp_test/lib/libdeepmd_op_pt.so(+0xaeac3)[0x7f3e940fcac3]
    pytest.skip(reason="Known segfault, see comments for details")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 16172e6 and 830788a.

📒 Files selected for processing (2)
  • source/lmp/tests/run_mpi_pair_deepmd.py (2 hunks)
  • source/lmp/tests/test_lammps_dpa_pt_nopbc.py (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
source/lmp/tests/run_mpi_pair_deepmd.py (1)

24-24: LGTM: New command-line argument added correctly.

The addition of the --nopbc argument as a boolean flag is implemented correctly and aligns with the PR objectives. The argument name is clear and descriptive.

source/lmp/tests/test_lammps_dpa_pt_nopbc.py Show resolved Hide resolved
source/lmp/tests/test_lammps_dpa_pt_nopbc.py Show resolved Hide resolved
source/lmp/tests/test_lammps_dpa_pt_nopbc.py Show resolved Hide resolved
Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.50%. Comparing base (16172e6) to head (830788a).
Report is 6 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4220   +/-   ##
=======================================
  Coverage   83.50%   83.50%           
=======================================
  Files         541      541           
  Lines       52486    52486           
  Branches     3043     3047    +4     
=======================================
+ Hits        43830    43831    +1     
  Misses       7708     7708           
+ Partials      948      947    -1     

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

@iProzd iProzd added this pull request to the merge queue Oct 17, 2024
github-merge-queue bot pushed a commit that referenced this pull request Oct 17, 2024
Adding tests to see whether #4167 is resolved. The answer is no.
Segfaults are thrown with MPI.

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

## Summary by CodeRabbit

- **New Features**
- Introduced a new command-line argument `--nopbc` to modify boundary
conditions in LAMMPS simulations.
- **Tests**
- Added a comprehensive suite of unit tests for the DeepMD potential in
LAMMPS, covering various configurations and scenarios to ensure accuracy
and reliability.

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

---------

Signed-off-by: Jinzhe Zeng <[email protected]>
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 17, 2024
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Oct 17, 2024
Merged via the queue into deepmodeling:devel with commit 1e1090a Oct 17, 2024
60 checks passed
github-merge-queue bot pushed a commit that referenced this pull request Oct 23, 2024
…4237)

fix errors mentioned in following pr:
#4220
#4209
#4144

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

- **New Features**
- Enhanced message passing logic in the computation process for improved
efficiency.
- Added new test functions to evaluate DeepMD model performance under
various conditions.

- **Bug Fixes**
- Improved error handling and assertions in test cases to ensure
robustness.

- **Refactor**
- Streamlined tensor operations in the communication process to enhance
clarity and reduce unnecessary computations.
- Removed outdated test cases related to neighbor list handling in the
DeepPot class.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

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.

4 participants