Skip to content

Commit 85e5e20

Browse files
authored
docs: document plugin mechanisms and deepmd-gnn (#4345)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced plugin mechanisms for external models in the DeePMD-kit. - Added comprehensive instructions for creating models using PyTorch and a framework-independent backend. - **Documentation** - Enhanced organization of the third-party documentation for better clarity and navigability. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
1 parent 7416c9f commit 85e5e20

File tree

3 files changed

+23
-9
lines changed

3 files changed

+23
-9
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ See [our latest paper](https://doi.org/10.1063/5.0155600) for details of all fea
7474

7575
- Multiple backends supported. Add PyTorch and JAX backends.
7676
- The DPA-2 model.
77+
- Plugin mechanisms for external models.
7778

7879
## Install and use DeePMD-kit
7980

doc/development/create-a-model-pt.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ The arguments here should be consistent with the class arguments of your new com
180180
## Package new codes
181181

182182
You may package new codes into a new Python package if you don't want to contribute it to the main DeePMD-kit repository.
183+
A good example is [DeePMD-GNN](https://github.com/njzjz/deepmd-gnn).
183184
It's crucial to add your new component to `project.entry-points."deepmd.pt"` in `pyproject.toml`:
184185

185186
```toml

doc/third-party/out-of-deepmd-kit.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,21 @@
22

33
The codes of the following interfaces are not a part of the DeePMD-kit package and maintained by other repositories. We list these interfaces here for user convenience.
44

5-
## OpenMM plugin for DeePMD-kit
5+
## Plugins
6+
7+
### External GNN models (MACE/NequIP)
8+
9+
[DeePMD-GNN](https://github.com/njzjz/deepmd-gnn) is DeePMD-kit plugin for various graph neural network (GNN) models.
10+
It has interfaced with [MACE](https://github.com/ACEsuit/mace) (PyTorch version) and [NequIP](https://github.com/mir-group/nequip) (PyTorch version).
11+
It is also the first example to the DeePMD-kit [plugin mechanism](../development/create-a-model-pt.md#package-new-codes).
12+
13+
## C/C++ interface used by other packages
14+
15+
### OpenMM plugin for DeePMD-kit
616

717
An [OpenMM](https://github.com/openmm/openmm) plugin is provided from [JingHuangLab/openmm_deepmd_plugin](https://github.com/JingHuangLab/openmm_deepmd_plugin), written by the [Huang Lab](http://www.compbiophysics.org/) at Westlake University.
818

9-
## Amber interface to DeePMD-kit
19+
### Amber interface to DeePMD-kit
1020

1121
Starting from [AmberTools24](https://ambermd.org/), `sander` includes an interface to the DeePMD-kit, which implements the [Deep Potential Range Corrected (DPRc) correction](../model/dprc.md).
1222
The DPRc model and the interface were developed by the [York Lab](https://theory.rutgers.edu/) from Rutgers University.
@@ -17,18 +27,20 @@ More details are available in
1727
- [DP-Amber](https://github.com/njzjz/dpamber/), a tiny tool to convert Amber trajectory to DPRc training data;
1828
- [The original DPRc paper](https://doi.org/10.1021/acs.jctc.1c00201).
1929

20-
## CP2K interface to DeePMD-kit
30+
### CP2K interface to DeePMD-kit
2131

2232
[CP2K](https://github.com/cp2k/cp2k/) v2024.2 adds an interface to the DeePMD-kit for molecular dynamics. Read the [CP2K manual](https://manual.cp2k.org/trunk/methods/machine_learning/deepmd.html#deepmd-kit) for details.
2333

24-
## DP-GEN
34+
### ABACUS
2535

26-
[DP-GEN](https://github.com/deepmodeling/dpgen) provides a workflow to generate accurate DP models by calling DeePMD-kit's command line interface (CLI) in the local or remote server. Details can be found in [this paper](https://doi.org/10.1016/j.cpc.2020.107206).
36+
[ABACUS](https://github.com/deepmodeling/abacus-develop/) can run molecular dynamics with a DP model. User is required to [build ABACUS with DeePMD-kit](https://abacus.deepmodeling.com/en/latest/advanced/install.html#build-with-deepmd-kit).
2737

28-
## MLatom
38+
## Command line interface used by other packages
2939

30-
[Mlatom](http://mlatom.com/) provides an interface to the DeePMD-kit within MLatom's workflow by calling DeePMD-kit's CLI. Details can be found in [this paper](https://doi.org/10.1007/s41061-021-00339-5).
40+
### DP-GEN
3141

32-
## ABACUS
42+
[DP-GEN](https://github.com/deepmodeling/dpgen) provides a workflow to generate accurate DP models by calling DeePMD-kit's command line interface (CLI) in the local or remote server. Details can be found in [this paper](https://doi.org/10.1016/j.cpc.2020.107206).
3343

34-
[ABACUS](https://github.com/deepmodeling/abacus-develop/) can run molecular dynamics with a DP model. User is required to [build ABACUS with DeePMD-kit](https://abacus.deepmodeling.com/en/latest/advanced/install.html#build-with-deepmd-kit).
44+
### MLatom
45+
46+
[Mlatom](http://mlatom.com/) provides an interface to the DeePMD-kit within MLatom's workflow by calling DeePMD-kit's CLI. Details can be found in [this paper](https://doi.org/10.1007/s41061-021-00339-5).

0 commit comments

Comments
 (0)