Skip to content

Commit aa7bc82

Browse files
committed
docs: clarify LoRA scope and update DPA-3 citation
1 parent fc64ecf commit aa7bc82

3 files changed

Lines changed: 42 additions & 34 deletions

File tree

CITATIONS.bib

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -224,18 +224,17 @@ @article{Zhang_npjComputMater_2024_v10_p293
224224
doi = {10.1038/s41524-024-01493-2},
225225
}
226226

227-
@misc{Zhang_2025_DPA3,
227+
@article{Zhang_npjComputMater_2026_DPA3,
228228
annote = {DPA-3 descriptor (dpa3)},
229229
author = {
230230
Duo Zhang and Anyang Peng and Chun Cai and Wentao Li and Yuanchang Zhou and
231231
Jinzhe Zeng and Mingyu Guo and Chengqian Zhang and Bowen Li and Hong Jiang
232232
and Tong Zhu and Weile Jia and Linfeng Zhang and Han Wang
233233
},
234234
title = {{A Graph Neural Network for the Era of Large Atomistic Models}},
235-
publisher = {arXiv},
236-
year = 2025,
237-
doi = {10.48550/arXiv.2506.01686},
238-
url = {https://arxiv.org/abs/2506.01686},
235+
journal = {npj Comput. Mater.},
236+
year = 2026,
237+
doi = {10.1038/s41524-026-02146-2},
239238
}
240239

241240
@misc{Li_2026_DPA4,

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ and deploy it at simulation scale.**
2020

2121
> [!IMPORTANT]
2222
> **A pretrained model can be your starting point, not just your end result.**
23-
> Download a built-in DPA checkpoint, fine-tune the full model or a LoRA
24-
> adapter on system-specific data, then test, export, and deploy it through the
25-
> same DeePMD-kit workflow.
23+
> Download a built-in DPA checkpoint, fine-tune the full model, or use a
24+
> [DPA-4 LoRA adapter][dpa4-lora] with PyTorch single-task training, then test,
25+
> export, and deploy it through the same DeePMD-kit workflow.
2626
2727
DeePMD-kit turns quantum-mechanical reference data into fast, scalable
2828
interatomic potentials. Use it across molecular and materials science—from
@@ -38,16 +38,16 @@ dynamics.
3838

3939
## ⚡ Why DeePMD-kit
4040

41-
| | Advantage | What it unlocks |
42-
| --- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
43-
| 🧬 | **Pretrained-first workflows** | Download [pretrained DPA models][pretrained], fine-tune full models or LoRA adapters, or adapt learned representations to downstream properties with [DPA-ADAPT]. |
44-
| 🏗️ | **Training from scratch** | Design a model for a new system or physical target, then train it with single-task, multi-task, and distributed workflows across supported backends. |
45-
| 🧠 | **Modern model portfolio** | Start with efficient DeepPot-SE descriptors or move to [DPA][model-guide] for large atomistic models. |
46-
| 🧲 | **More than energy and force** | Model virials, Hessians, spin and magnetic forces, dipoles, polarizabilities, electronic density of states, atomic populations, and arbitrary intensive or extensive properties. |
47-
| 🔄 | **Backend flexibility** | Train or run supported models with [TensorFlow, PyTorch, JAX, or Paddle][backends], with backend-aware model formats and conversion paths for compatible architectures. |
48-
| 🚀 | **Performance from training to MD** | Use CPUs, CUDA GPUs, ROCm source builds, distributed training, model compression, compiled DPA-4 paths, AOTInductor `.pt2` export, and MPI-enabled simulation. |
49-
| 🔌 | **Deploy where science happens** | Use the CLI, Python, C, C++, or Node.js, then connect models to LAMMPS, i-PI, ASE, GROMACS, JAX MD, nvalchemi, OpenMM, Amber, CP2K, ABACUS, and more. |
50-
| 🧩 | **Open and extensible** | Compose hybrid potentials, add analytical ZBL or long-range corrections, create custom models and operators, or connect external GNNs such as MACE and NequIP through plugins. |
41+
| | Advantage | What it unlocks |
42+
| --- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
43+
| 🧬 | **Pretrained-first workflows** | Download [pretrained DPA models][pretrained], fine-tune full models, use [DPA-4 LoRA adapters][dpa4-lora] with PyTorch single-task training, or adapt learned representations to downstream properties with [DPA-ADAPT]. |
44+
| 🏗️ | **Training from scratch** | Design a model for a new system or physical target, then train it with single-task, multi-task, and distributed workflows across supported backends. |
45+
| 🧠 | **Modern model portfolio** | Start with efficient DeepPot-SE descriptors or move to [DPA][model-guide] for large atomistic models. |
46+
| 🧲 | **More than energy and force** | Model virials, Hessians, spin and magnetic forces, dipoles, polarizabilities, electronic density of states, atomic populations, and arbitrary intensive or extensive properties. |
47+
| 🔄 | **Backend flexibility** | Train or run supported models with [TensorFlow, PyTorch, JAX, or Paddle][backends], with backend-aware model formats and conversion paths for compatible architectures. |
48+
| 🚀 | **Performance from training to MD** | Use CPUs, CUDA GPUs, ROCm source builds, distributed training, model compression, compiled DPA-4 paths, AOTInductor `.pt2` export, and MPI-enabled simulation. |
49+
| 🔌 | **Deploy where science happens** | Use the CLI, Python, C, C++, or Node.js, then connect models to LAMMPS, i-PI, ASE, GROMACS, JAX MD, nvalchemi, OpenMM, Amber, CP2K, ABACUS, and more. |
50+
| 🧩 | **Open and extensible** | Compose hybrid potentials, add analytical ZBL or long-range corrections, create custom models and operators, or connect external GNNs such as MACE and NequIP through plugins. |
5151

5252
> [!TIP]
5353
> On supported descriptors and workloads, [model compression][compression] can
@@ -76,9 +76,10 @@ flowchart LR
7676
adaptation, or configure a model to train from scratch.
7777
1. **Prepare target data** in DeePMD's NumPy format or convert structures and
7878
trajectories with [dpdata][data].
79-
1. **Fine-tune or train:** adapt the full pretrained model or LoRA adapters,
80-
or optimize a new model with single-task, multi-task, and distributed
81-
training workflows.
79+
1. **Fine-tune or train:** adapt the full pretrained model, use
80+
[DPA-4 LoRA adapters][dpa4-lora] with PyTorch single-task training, or
81+
optimize a new model with single-task, multi-task, and distributed training
82+
workflows.
8283
1. **Validate and export** with [`dp test`][testing], [`dp freeze`][freeze],
8384
backend conversion, embedding extraction, and supported compression paths.
8485
1. **Run simulation** through Python or native APIs, or load the model into a
@@ -119,7 +120,8 @@ mode with `dp --pt` and select the branch that matches your system with
119120
configuration, so `input.json` does not need to reproduce the DPA-3.2
120121
architecture.
121122

122-
The [fine-tuning guide][finetune] covers full-model and LoRA adaptation.
123+
The [fine-tuning guide][finetune] covers full-model adaptation. [DPA-4 LoRA
124+
fine-tuning][dpa4-lora] is available for PyTorch single-task training.
123125
[DPA-ADAPT] reuses pretrained DPA representations for downstream
124126
property-prediction tasks.
125127

@@ -256,6 +258,7 @@ DeePMD-kit is licensed under the
256258
[data]: https://docs.deepmodeling.com/projects/deepmd/en/latest/data/dpdata.html
257259
[documentation]: https://docs.deepmodeling.com/projects/deepmd/en/latest/
258260
[dpa-adapt]: https://docs.deepmodeling.com/projects/deepmd/en/latest/dpa_adapt/overview.html
261+
[dpa4-lora]: https://docs.deepmodeling.com/projects/deepmd/en/latest/model/dpa4.html#lora-fine-tuning
259262
[embeddings]: https://docs.deepmodeling.com/projects/deepmd/en/latest/inference/embedding.html
260263
[finetune]: https://docs.deepmodeling.com/projects/deepmd/en/latest/train/finetuning.html
261264
[freeze]: https://docs.deepmodeling.com/projects/deepmd/en/latest/freeze/freeze.html

doc/index.rst

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ DeePMD-kit
1010
.. important::
1111

1212
**A pretrained model can be your starting point, not just your end result.**
13-
Download a built-in DPA checkpoint, fine-tune the full model or a LoRA
14-
adapter on system-specific data, then test, export, and deploy it through
15-
the same DeePMD-kit workflow.
13+
Download a built-in DPA checkpoint, fine-tune the full model, or use
14+
`DPA-4 LoRA`_ with PyTorch single-task training, then test, export, and deploy
15+
it through the same DeePMD-kit workflow.
1616

1717
DeePMD-kit turns quantum-mechanical reference data into fast, scalable
1818
interatomic potentials. Use it across molecular and materials science—from
@@ -46,7 +46,8 @@ Choose your path
4646
:link-type: doc
4747
:shadow: md
4848

49-
Adapt a full pretrained model or LoRA adapters to your target system.
49+
Adapt a full pretrained model, or use DPA-4 LoRA with PyTorch single-task
50+
training.
5051

5152
.. grid-item-card:: 🏗️ Train from scratch
5253
:link: train/index
@@ -81,8 +82,9 @@ Why DeePMD-kit
8182
.. grid-item-card:: Pretrained-first adaptation
8283
:shadow: sm
8384

84-
Start from built-in DPA checkpoints, fine-tune full models or LoRA
85-
adapters, and reuse learned representations with DPA-ADAPT.
85+
Start from built-in DPA checkpoints, fine-tune full models, use
86+
`DPA-4 LoRA`_ with PyTorch single-task training, and reuse learned
87+
representations with DPA-ADAPT.
8688

8789
.. grid-item-card:: Training from scratch
8890
:link: train/index
@@ -156,7 +158,7 @@ Two starting points, one path to dynamics
156158
:link: train/finetuning
157159
:link-type: doc
158160

159-
Adapt the full model or LoRA adapters to your system.
161+
Adapt the full model, or use DPA-4 LoRA with PyTorch single-task training.
160162

161163
.. grid-item-card:: 3 · Train
162164
:link: train/index
@@ -177,7 +179,8 @@ Two starting points, one path to dynamics
177179
Run inference directly or deploy into molecular dynamics.
178180

179181
Fine-tuning and from-scratch training converge on the same validation, export,
180-
and deployment toolchain.
182+
and deployment toolchain. `DPA-4 LoRA`_ is currently limited to PyTorch
183+
single-task fine-tuning.
181184

182185
Choose a model family
183186
=====================
@@ -200,8 +203,9 @@ Choose a model family
200203
- Message passing over line-graph representations and broad chemical
201204
coverage.
202205
* - :doc:`DPA-4 <model/dpa4>`
203-
- SO(3)-equivariant learning, LoRA fine-tuning, optional ZBL bridging,
204-
spin support, and compiled ``.pt2`` deployment.
206+
- SO(3)-equivariant learning, `DPA-4 LoRA`_ for PyTorch single-task
207+
fine-tuning, optional ZBL bridging, spin support, and compiled ``.pt2``
208+
deployment.
205209

206210
.. figure:: _static/dpa4-performance.webp
207211
:alt: DPA4 energy and force accuracy versus saturated throughput
@@ -256,8 +260,8 @@ New and noteworthy
256260
:link-type: doc
257261
:shadow: sm
258262

259-
Equivariant message passing, LoRA, ZBL, spin, compiled inference, and
260-
LAMMPS deployment.
263+
Equivariant message passing, PyTorch single-task LoRA, ZBL, spin,
264+
compiled inference, and LAMMPS deployment.
261265

262266
.. grid-item-card:: DPA-ADAPT
263267
:link: dpa_adapt/index
@@ -425,5 +429,7 @@ Indices
425429
* :ref:`modindex`
426430
* :ref:`search`
427431

432+
.. _DPA-4 LoRA: https://docs.deepmodeling.com/projects/deepmd/en/latest/model/dpa4.html#lora-fine-tuning
433+
428434
.. _feedback:
429435
.. _affiliated packages:

0 commit comments

Comments
 (0)