chore: test consistency of rotation matrix

[njzjz]

Summary by CodeRabbit

• Tests
  • Updated test methods in multiple descriptor test files to return two-element tuples instead of single-element tuples
  • Modified build_tf_descriptor method to include rotation matrix in the return value

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces modifications to several test descriptor files in the source/tests/consistent/descriptor/ directory. The changes primarily involve expanding the return values of the extract_ret methods in multiple test classes from single-element to two-element tuples. Additionally, the build_tf_descriptor method in the common descriptor file is updated to include an additional element (rotation matrix) in its return value. These modifications suggest a consistent approach to enhancing the output of descriptor-related test methods across different descriptor implementations.

Changes

File	Change Summary
source/tests/consistent/descriptor/common.py	Modified build_tf_descriptor method to return [t_des, obj.get_rot_mat()] instead of [t_des]
source/tests/consistent/descriptor/test_*.py	Updated extract_ret methods to return (ret[0], ret[1]) instead of (ret[0],) in multiple descriptor test classes

Possibly related PRs

• feat(dp/pt): refactor se_e3 descriptor #3813: Changes to extract_ret method returning two-element tuples
• fix: correct exclude_types in descriptors #3841: Modifications to extract_ret methods across different descriptors

Suggested labels

Python, Docs, Examples

Suggested reviewers

• wanghan-iapcm
• iProzd

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65ca05a and e88f183.

📒 Files selected for processing (5)

• source/tests/consistent/descriptor/common.py (1 hunks)
• source/tests/consistent/descriptor/test_dpa1.py (1 hunks)
• source/tests/consistent/descriptor/test_hybrid.py (1 hunks)
• source/tests/consistent/descriptor/test_se_atten_v2.py (1 hunks)
• source/tests/consistent/descriptor/test_se_e2_a.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: Build wheels for cp310-manylinux_aarch64
• GitHub Check: Build C library (2.14, >=2.5.0rc0,<2.15, libdeepmd_c_cu11.tar.gz)
• GitHub Check: Test C++ (false)
• GitHub Check: Test C++ (true)
• GitHub Check: Build C library (2.18, libdeepmd_c.tar.gz)

🔇 Additional comments (5)

source/tests/consistent/descriptor/common.py (1)

77-77: LGTM! Enhanced test coverage for rotation matrix validation.

The addition of obj.get_rot_mat() to the return value enables testing the consistency of rotation matrices across different implementations (TensorFlow, PyTorch, JAX, etc.).

source/tests/consistent/descriptor/test_hybrid.py (1)

171-171: LGTM! Consistent with base class changes.

Updated to return both the descriptor and rotation matrix, aligning with the changes in the base descriptor test class.

source/tests/consistent/descriptor/test_se_e2_a.py (1)

262-262: LGTM! Consistent with other descriptor tests.

Updated to return both the descriptor and rotation matrix, maintaining consistency across all descriptor test implementations.

source/tests/consistent/descriptor/test_se_atten_v2.py (1)

343-343: LGTM! Completes the test coverage enhancement.

Updated to return both the descriptor and rotation matrix, completing the consistent implementation across all descriptor test classes. This change ensures that rotation matrices are properly validated across different backend implementations.

source/tests/consistent/descriptor/test_dpa1.py (1)

445-445: LGTM! Consistent with other descriptor test changes.

The modification to return both elements from the descriptor output aligns with similar changes in other test files (TestHybrid, TestSeAttenV2, TestSeA) and supports testing the consistency of rotation matrices.

Let's verify the consistency of this change with other descriptor test files:

✅ Verification successful

Implementation is correct as not all descriptors support rotation matrices

The extract_ret method returning both elements (ret[0], ret[1]) is consistent with other descriptors that support rotation matrices (Hybrid, SeAttenV2, SeE2A), while other descriptors (DPA2, SeR, SeT, SeTTebd) correctly maintain single-element returns.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that all descriptor test files have been updated consistently
# to return both elements in their extract_ret methods

# Search for extract_ret method implementations across all descriptor test files
rg -U "def extract_ret.*?\{.*?return.*?\}" source/tests/consistent/descriptor/

Length of output: 80

---

Script:

#!/bin/bash
# First, find all test files in the descriptor directory
echo "=== Test files in descriptor directory ==="
fd "test_.*\.py$" source/tests/consistent/descriptor/

# Then use ast-grep to find extract_ret method implementations
echo -e "\n=== extract_ret implementations ==="
ast-grep --pattern 'def extract_ret($$$) { $$$ return $$$ }'

Length of output: 701

---

Script:

#!/bin/bash
# Search for extract_ret methods and their return statements in all test files
for file in $(fd "test_.*\.py$" source/tests/consistent/descriptor/); do
    echo "=== $file ==="
    rg "extract_ret.*|.*return.*" "$file" -B 1 -A 1
done

Length of output: 15414

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.57%. Comparing base (65ca05a) to head (e88f183).
Report is 2 commits behind head on devel.

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #4550      +/-   ##
==========================================
- Coverage   84.57%   84.57%   -0.01%     
==========================================
  Files         677      677              
  Lines       63916    63915       -1     
  Branches     3486     3486              
==========================================
- Hits        54060    54059       -1     
+ Misses       8730     8729       -1     
- Partials     1126     1127       +1     

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