Commit bf982ab
authored
docs: add mathematical formulas to fitting classes (#5256)
## Summary
Add detailed mathematical formulas to fitting class docstrings following
numpydoc convention.
## Changes
Added formulas to the following classes:
- **DipoleFitting**: Dipole computation from rotation matrix
- Formula: μ = M · R where M is fitting network output and R is rotation
matrix
- **PolarFitting**: Polarizability tensor with diagonal/full fitting
modes
- Diagonal fitting: α = R^T · diag(p) · R
- Full matrix fitting: α = R^T · P · R
## Convention
Following numpydoc convention, parameters are documented in class
docstrings, not in `__init__` docstrings.
## Statistics
- 2 files changed
- 41 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 mathematical documentation for dipole computation from model
outputs and rotation matrices; clarified notation and step-by-step
calculations.
* Added detailed explanations of polarizability tensor fitting for both
diagonal and full-matrix approaches, including how rotation information
integrates with network outputs.
* Clarified assumptions and computation flow; no functional behavior
changes.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->1 parent 43b5809 commit bf982ab
2 files changed
Lines changed: 47 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | | - | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
38 | 55 | | |
39 | 56 | | |
40 | 57 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
47 | 76 | | |
48 | 77 | | |
49 | 78 | | |
| |||
0 commit comments