breaking(pt/dp):change env_protection for spin

[iProzd]

Summary by CodeRabbit

• New Features

  • Updated documentation for incorporating spin information into energy models for TensorFlow and PyTorch, enhancing clarity and usability.
  • Added detailed instructions on spin settings, loss functions, and data formats for both backends.

• Bug Fixes

  • Adjusted the default value of the env_protection parameter to improve model handling of environmental protection during computations.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request includes modifications to the get_spin_model function in the deepmd/pt/model/model/__init__.py file, specifically changing the default value of the env_protection parameter from 1e-6 to 0.01. Additionally, the train-energy-spin.md document has been updated to provide detailed instructions on incorporating spin information into energy models for both TensorFlow and PyTorch backends, including adjustments to parameters and handling of spin data.

Changes

File	Change Summary
deepmd/pt/model/model/__init__.py	Modified the get_spin_model function to change env_protection default value from 1e-6 to 0.01.
doc/model/train-energy-spin.md	Updated to include instructions for incorporating spin in energy models, detailing parameters and data formats.

Possibly related PRs

• doc: update spin lmp doc and example #4375: The changes in train-energy-spin.md regarding the handling of spin settings and the env_protection parameter are directly related to the modifications made in the main PR, which also involves the env_protection parameter in the get_spin_model function.

Suggested labels

Docs

Suggested reviewers

• njzjz
• wanghan-iapcm

---

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

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)

doc/model/train-energy-spin.md (1)

74-80: Consider adding migration guidance

Since this is a breaking change, it would be helpful to add migration guidance for users updating from previous versions.

Consider adding:

 For systems with nearly zero spin, users can also consider tuning this parameter to potentially enhance stability.
+
+If you are upgrading from a previous version and want to maintain the old behavior, you can explicitly set `env_protection: 1e-6` in your descriptor configuration.

🧰 Tools

🪛 LanguageTool

[style] ~76-~76: To make your writing clearer, consider a shorter, more direct word.
Context: ...es zero (indicating the virtual atom is in close proximity to the real atom) by adjusting the non-zer...

(CLOSE_PROXIMITY)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 142ac39 and 862c0e4.

📒 Files selected for processing (2)

• deepmd/pt/model/model/__init__.py (1 hunks)
• doc/model/train-energy-spin.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

doc/model/train-energy-spin.md

[style] ~76-~76: To make your writing clearer, consider a shorter, more direct word.
Context: ...es zero (indicating the virtual atom is in close proximity to the real atom) by adjusting the non-zer...

(CLOSE_PROXIMITY)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.50%. Comparing base (142ac39) to head (862c0e4).
Report is 93 commits behind head on devel.

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #4394      +/-   ##
==========================================
- Coverage   84.50%   84.50%   -0.01%     
==========================================
  Files         604      604              
  Lines       56944    56945       +1     
  Branches     3486     3486              
==========================================
- Hits        48122    48119       -3     
- Misses       7697     7698       +1     
- Partials     1125     1128       +3     

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