Skip to content

Commit 43e0288

Browse files
authored
docs: update the citation of deepmd-kit v3 (deepmodeling#4738)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated all references and citations for the DeePMD-kit v3 paper from the previous arXiv preprint to the formal journal publication in the Journal of Chemical Theory and Computation, including updated DOI, volume, issue, and page numbers. - Enhanced citation entries with a detailed abstract and corrected bibliographic metadata. - Updated citation badges and links in documentation to reference the published article. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
1 parent 8c6e2ea commit 43e0288

6 files changed

Lines changed: 47 additions & 22 deletions

File tree

CITATIONS.bib

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ @article{Zeng_JChemPhys_2023_v159_p054801
4040
doi = {10.1063/5.0155600},
4141
}
4242

43-
@article{Zeng_arXiv_2025_p2502.19161,
43+
@article{Zeng_JChemTheoryComput_2025_v21_p4375,
4444
annote = {general purpose},
4545
author = {
4646
Jinzhe Zeng and Duo Zhang and Anyang Peng and Xiangyu Zhang and Sensen He
@@ -59,10 +59,31 @@ @article{Zeng_arXiv_2025_p2502.19161
5959
{DeePMD-kit v3: A Multiple-Backend Framework for Machine Learning
6060
Potentials}
6161
},
62-
journal = {arXiv},
62+
journal = {J. Chem. Theory Comput.},
6363
year = 2025,
64-
pages = {2502.19161},
65-
doi = {10.48550/arXiv.2502.19161},
64+
volume = 21,
65+
number = 9,
66+
pages = {4375--4385},
67+
doi = {10.1021/acs.jctc.5c00340},
68+
abstract = {
69+
In recent years, machine learning potentials (MLPs) have become
70+
indispensable tools in physics, chemistry, and materials science, driving
71+
the development of software packages for molecular dynamics (MD)
72+
simulations and related applications. These packages, typically built on
73+
specific machine learning frameworks, such as TensorFlow, PyTorch, or JAX,
74+
face integration challenges when advanced applications demand communication
75+
across different frameworks. The previous TensorFlow-based implementation
76+
of the DeePMD-kit exemplified these limitations. In this work, we introduce
77+
DeePMD-kit version 3, a significant update featuring a multibackend
78+
framework that supports TensorFlow, PyTorch, JAX, and PaddlePaddle
79+
backends, and demonstrate the versatility of this architecture through the
80+
integration of other MLP packages and of differentiable molecular force
81+
fields. This architecture allows seamless back-end switching with minimal
82+
modifications, enabling users and developers to integrate DeePMD-kit with
83+
other packages using different machine learning frameworks. This innovation
84+
facilitates the development of more complex and interoperable workflows,
85+
paving the way for broader applications of MLPs in scientific research.
86+
},
6687
}
6788

6889
@article{Lu_CompPhysCommun_2021_v259_p107624,

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ If you use this code in any future publications, please cite the following publi
3636
- 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. "DeePMD-kit v2: A software package for deep potential models." J. Chem. Phys. 159 (2023): 054801.
3737
[![doi:10.1063/5.0155600](https://img.shields.io/badge/DOI-10.1063%2F5.0155600-blue)](https://doi.org/10.1063/5.0155600)
3838
[![Citations](https://citations.njzjz.win/10.1063/5.0155600)](https://badge.dimensions.ai/details/doi/10.1063/5.0155600)
39-
- Jinzhe Zeng, Duo Zhang, Anyang Peng, Xiangyu Zhang, Sensen He, Yan Wang, Xinzijian Liu, Hangrui Bi, Yifan Li, Chun Cai, Chengqian Zhang, Yiming Du, Jia-Xin Zhu, Pinghui Mo, Zhengtao Huang, Qiyu Zeng, Shaochen Shi, Xuejian Qin, Zhaoxi Yu, Chenxing Luo, Ye Ding, Yun-Pei Liu, Ruosong Shi, Zhenyu Wang, Sigbjørn Løland Bore, Junhan Chang, Zhe Deng, Zhaohan Ding, Siyuan Han, Wanrun Jiang, Guolin Ke, Zhaoqing Liu, Denghui Lu, Koki Muraoka, Hananeh Oliaei, Anurag Kumar Singh, Haohui Que, Weihong Xu, Zhangmancang Xu, Yong-Bin Zhuang, Jiayu Dai, Timothy J. Giese, Weile Jia, Ben Xu, Darrin M. York, Linfeng Zhang, Han Wang. "DeePMD-kit v3: A Multiple-Backend Framework for Machine Learning Potentials." [arXiv:2502.19161](https://arxiv.org/abs/2502.19161).
39+
- Jinzhe Zeng, Duo Zhang, Anyang Peng, Xiangyu Zhang, Sensen He, Yan Wang, Xinzijian Liu, Hangrui Bi, Yifan Li, Chun Cai, Chengqian Zhang, Yiming Du, Jia-Xin Zhu, Pinghui Mo, Zhengtao Huang, Qiyu Zeng, Shaochen Shi, Xuejian Qin, Zhaoxi Yu, Chenxing Luo, Ye Ding, Yun-Pei Liu, Ruosong Shi, Zhenyu Wang, Sigbjørn Løland Bore, Junhan Chang, Zhe Deng, Zhaohan Ding, Siyuan Han, Wanrun Jiang, Guolin Ke, Zhaoqing Liu, Denghui Lu, Koki Muraoka, Hananeh Oliaei, Anurag Kumar Singh, Haohui Que, Weihong Xu, Zhangmancang Xu, Yong-Bin Zhuang, Jiayu Dai, Timothy J. Giese, Weile Jia, Ben Xu, Darrin M. York, Linfeng Zhang, Han Wang. "DeePMD-kit v3: A Multiple-Backend Framework for Machine Learning Potentials." J. Chem. Theory Comput. 21 (2025): 4375-4385.
40+
[![doi:10.1021/acs.jctc.5c00340](https://img.shields.io/badge/DOI-10.1021%2Facs.jctc.5c00340-blue)](https://doi.org/10.1021/acs.jctc.5c00340)
41+
[![Citations](https://citations.njzjz.win/10.1021/acs.jctc.5c00340)](https://badge.dimensions.ai/details/doi/10.1021/acs.jctc.5c00340)
4042

4143
In addition, please follow [the bib file](CITATIONS.bib) to cite the methods you used.
4244

@@ -77,7 +79,7 @@ See [our v2 paper](https://doi.org/10.1063/5.0155600) for details of all feature
7779
- The DPA-2 model.
7880
- Plugin mechanisms for external models.
7981

80-
See [our v3 paper](https://doi.org/10.48550/arXiv.2502.19161) for details of all features until v3.0.
82+
See [our v3 paper](https://doi.org/10.1021/acs.jctc.5c00340) for details of all features until v3.0.
8183

8284
## Install and use DeePMD-kit
8385

deepmd/utils/summary.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class SummaryPrinter(ABC):
4242
"Please read and cite:",
4343
"Wang, Zhang, Han and E, Comput.Phys.Comm. 228, 178-184 (2018)",
4444
"Zeng et al, J. Chem. Phys., 159, 054801 (2023)",
45-
"Zeng et al, arxiv:2502.19161",
45+
"Zeng et al, J. Chem. Theory Comput., 21, 4375-4385 (2025)",
4646
"See https://deepmd.rtfd.io/credits/ for details.",
4747
)
4848

doc/credits.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Cite DeePMD-kit and methods
1313

1414
Wang_ComputPhysCommun_2018_v228_p178
1515
Zeng_JChemPhys_2023_v159_p054801
16-
Zeng_arXiv_2025_p2502.19161
16+
Zeng_JChemTheoryComput_2025_v21_p4375
1717

1818
- If GPU version is used,
1919

source/lmp/pair_deepmd.cpp

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,8 @@ static const char cite_user_deepmd_package[] =
8383
" pages = 054801,\n"
8484
" doi = {10.1063/5.0155600},\n"
8585
"}\n"
86-
"@Article{Zeng_arXiv_2025_p2502.19161,\n"
87-
" annote = {general purpose},\n"
88-
" author = {Jinzhe Zeng and Duo Zhang and Anyang Peng and Xiangyu "
86+
"@Article{Zeng_JChemTheoryComput_2025_v21_p4375,\n"
87+
" author = {Jinzhe Zeng and Duo Zhang and Anyang Peng and Xiangyu "
8988
"Zhang and Sensen\n"
9089
" He and Yan Wang and Xinzijian Liu and Hangrui Bi and Yifan "
9190
"Li and Chun\n"
@@ -110,10 +109,12 @@ static const char cite_user_deepmd_package[] =
110109
" title = {{DeePMD-kit v3: A Multiple-Backend Framework for Machine "
111110
"Learning\n"
112111
" Potentials}},\n"
113-
" journal = {arXiv},\n"
114-
" year = 2025,\n"
115-
" pages = {2502.19161},\n"
116-
" doi = {10.48550/arXiv.2502.19161},\n"
112+
" journal = {J. Chem. Theory Comput.},\n"
113+
" year = 2025,\n"
114+
" volume = 21,\n"
115+
" number = 9,\n"
116+
" pages = {4375--4385},\n"
117+
" doi = {10.1021/acs.jctc.5c00340},\n"
117118
"}\n\n";
118119

119120
PairDeepMD::PairDeepMD(LAMMPS *lmp)

source/lmp/pair_deepspin.cpp

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,8 @@ static const char cite_user_deepmd_package[] =
8383
" pages = 054801,\n"
8484
" doi = {10.1063/5.0155600},\n"
8585
"}\n"
86-
"@Article{Zeng_arXiv_2025_p2502.19161,\n"
87-
" annote = {general purpose},\n"
88-
" author = {Jinzhe Zeng and Duo Zhang and Anyang Peng and Xiangyu "
86+
"@Article{Zeng_JChemTheoryComput_2025_v21_p4375,\n"
87+
" author = {Jinzhe Zeng and Duo Zhang and Anyang Peng and Xiangyu "
8988
"Zhang and Sensen\n"
9089
" He and Yan Wang and Xinzijian Liu and Hangrui Bi and Yifan "
9190
"Li and Chun\n"
@@ -110,10 +109,12 @@ static const char cite_user_deepmd_package[] =
110109
" title = {{DeePMD-kit v3: A Multiple-Backend Framework for Machine "
111110
"Learning\n"
112111
" Potentials}},\n"
113-
" journal = {arXiv},\n"
114-
" year = 2025,\n"
115-
" pages = {2502.19161},\n"
116-
" doi = {10.48550/arXiv.2502.19161},\n"
112+
" journal = {J. Chem. Theory Comput.},\n"
113+
" year = 2025,\n"
114+
" volume = 21,\n"
115+
" number = 9,\n"
116+
" pages = {4375--4385},\n"
117+
" doi = {10.1021/acs.jctc.5c00340},\n"
117118
"}\n\n";
118119

119120
PairDeepSpin::PairDeepSpin(LAMMPS *lmp)

0 commit comments

Comments
 (0)