Skip to content

Commit

Permalink
docs: fix defination of se_e3 (#4113)
Browse files Browse the repository at this point in the history
As discussed in #4066

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


- **Documentation**
- Updated the description of the `se_e3` notation for improved clarity
regarding its relation to three-body embedding in DeepPot-SE.
- Enhanced explanation of bond-angle information in the context of the
embedding.

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

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Co-authored-by: Han Wang <92130845+wanghan-iapcm@users.noreply.github.com>
  • Loading branch information
njzjz and wanghan-iapcm authored Sep 11, 2024
1 parent ad891a7 commit b38098d
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/model/train-se-e3.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
**Supported backends**: TensorFlow {{ tensorflow_icon }}, PyTorch {{ pytorch_icon }}, DP {{ dpmodel_icon }}
:::

The notation of `se_e3` is short for the Deep Potential Smooth Edition (DeepPot-SE) constructed from all information (both angular and radial) of atomic configurations. The embedding takes bond angles between a central atom and its two neighboring atoms as input (denoted by `e3`).
The notation of `se_e3` is short for three-body embedding DeepPot-SE, which incorporates embedded bond-angle information.
The embedding takes bond angles between a central atom and its two neighboring atoms as input (denoted by `e3`).

## Theory

Expand Down

0 comments on commit b38098d

Please sign in to comment.