Skip to content

Commit

Permalink
Doc: ZBL pytorch (#3435)
Browse files Browse the repository at this point in the history
pytorch and tf should be able to use the same zbl input.json
#3498

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

## Summary by CodeRabbit

- **Documentation**
- Expanded the list of supported backends for interpolation or
combination with a pairwise potential in DeePMD-kit documentation to
include PyTorch and DP models alongside TensorFlow. Icons for each
backend have been added for clearer representation.

<!-- 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>
  • Loading branch information
anyangml and pre-commit-ci[bot] committed Apr 30, 2024
1 parent d0fe13c commit 95d92e9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/model/pairtab.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Interpolation or combination with a pairwise potential {{ tensorflow_icon }}
# Interpolation or combination with a pairwise potential {{ tensorflow_icon }} {{ pytorch_icon }} {{ dpmodel_icon }}

:::{note}
**Supported backends**: TensorFlow {{ tensorflow_icon }}
**Supported backends**: TensorFlow {{ tensorflow_icon }}, PyTorch {{ pytorch_icon }}, DP {{ dpmodel_icon }}
:::

## Theory
Expand Down Expand Up @@ -47,7 +47,7 @@ The pairwise potential $u^{\textrm{pair}}(r)$ is defined by a user-defined table

[^1]: This section is built upon Jinzhe Zeng, Duo Zhang, Denghui Lu, Pinghui Mo, Zeyu Li, Yixiao Chen, Marián Rynik, Li'ang Huang, Ziyao Li, Shaochen Shi, Yingze Wang, Haotian Ye, Ping Tuo, Jiabin Yang, Ye Ding, Yifan Li, Davide Tisi, Qiyu Zeng, Han Bao, Yu Xia, Jiameng Huang, Koki Muraoka, Yibo Wang, Junhan Chang, Fengbo Yuan, Sigbjørn Løland Bore, Chun Cai, Yinnian Lin, Bo Wang, Jiayan Xu, Jia-Xin Zhu, Chenxing Luo, Yuzhi Zhang, Rhys E. A. Goodall, Wenshuo Liang, Anurag Kumar Singh, Sikai Yao, Jingchao Zhang, Renata Wentzcovitch, Jiequn Han, Jie Liu, Weile Jia, Darrin M. York, Weinan E, Roberto Car, Linfeng Zhang, Han Wang, [J. Chem. Phys. 159, 054801 (2023)](https://doi.org/10.1063/5.0155600) licensed under a [Creative Commons Attribution (CC BY) license](http://creativecommons.org/licenses/by/4.0/).

DeePMD-kit also supports combination with a pairwise potential:
DeePMD-kit also supports combination with a pairwise potential {{ tensorflow_icon }}:

```math
E_i = E_i^{\mathrm{DP}} + E_i^{\mathrm{pair}},
Expand Down Expand Up @@ -80,7 +80,7 @@ In instances where the interaction at the cut-off distance is not delineated wit

{ref}`sw_rmin <model/sw_rmin>` and {ref}`sw_rmax <model/sw_rmax>` must be smaller than the cutoff radius of the DP model.

## Combination with a pairwise potential
## Combination with a pairwise potential {{ tensorflow_icon }}

To combine with a pairwise potential, use the [linear model](./linear.md):

Expand Down

0 comments on commit 95d92e9

Please sign in to comment.