Commit eaed387
docs: add mathematical formulas to model classes (#5258)
## Summary
Add detailed mathematical formulas to model class docstrings following
numpydoc convention.
## Changes
Added formulas to the following classes:
- **DPModelCommon**: Descriptor + fitting pipeline
- D = Descriptor(R, types)
- y = Fitting(D)
- **SpinModel**: Virtual atom positions and torque conversion
- r_virtual = r_real + s · σ
- τ = F_virtual × σ
## Convention
Following numpydoc convention, parameters are documented in class
docstrings, not in `__init__` docstrings.
## Statistics
- 2 files changed
- 35 insertions(+)
- 1 deletion(-)
Authored by OpenClaw (model: GLM-5)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Expanded user-facing documentation for core model components: model
reduction and differentiation math for energy/forces/virials, spin input
preprocessing, virtual-atom creation/placement, interactions among
real/virtual/ghost atoms, and conversion of virtual-atom forces into
magnetic torques. All changes are descriptive only; no functional or
behavioral modifications.
<!-- 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>1 parent 8eb2943 commit eaed387
3 files changed
Lines changed: 49 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
17 | 23 | | |
18 | 24 | | |
19 | 25 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
34 | 59 | | |
35 | 60 | | |
36 | 61 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
33 | 50 | | |
34 | 51 | | |
35 | 52 | | |
| |||
0 commit comments