Skip to content

Commit 2731c5d

Browse files
authored
Doc: update DPA3 reference (#4781)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated user documentation and README to reflect support for both DPA-2 and DPA-3 models. - Added references to the DPA-3 model paper in the documentation and class descriptions for improved citation and clarity. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 9ef43fa commit 2731c5d

5 files changed

Lines changed: 23 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ See [our v2 paper](https://doi.org/10.1063/5.0155600) for details of all feature
7676
#### v3
7777

7878
- Multiple backends supported. Add PyTorch and JAX backends.
79-
- The DPA-2 model.
79+
- The DPA-2 and DPA-3 models.
8080
- Plugin mechanisms for external models.
8181

8282
See [our v3 paper](https://doi.org/10.1021/acs.jctc.5c00340) for details of all features until v3.0.

deepmd/dpmodel/descriptor/dpa3.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ def deserialize(cls, data: dict) -> "RepFlowArgs":
251251

252252
@BaseDescriptor.register("dpa3")
253253
class DescrptDPA3(NativeOP, BaseDescriptor):
254-
r"""The DPA-3 descriptor.
254+
r"""The DPA-3 descriptor[1]_.
255255
256256
Parameters
257257
----------
@@ -282,6 +282,12 @@ class DescrptDPA3(NativeOP, BaseDescriptor):
282282
When True, local indexing and mapping are applied to neighbor lists and embeddings during descriptor computation.
283283
type_map : list[str], Optional
284284
A list of strings. Give the name to each type of atoms.
285+
286+
References
287+
----------
288+
.. [1] Zhang, D., Peng, A., Cai, C. et al. Graph neural
289+
network model for the era of large atomistic models.
290+
arXiv preprint arXiv:2506.01686 (2025).
285291
"""
286292

287293
def __init__(

deepmd/pd/model/descriptor/dpa3.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363

6464
@BaseDescriptor.register("dpa3")
6565
class DescrptDPA3(BaseDescriptor, paddle.nn.Layer):
66-
r"""The DPA-3 descriptor.
66+
r"""The DPA-3 descriptor[1]_.
6767
6868
Parameters
6969
----------
@@ -94,6 +94,12 @@ class DescrptDPA3(BaseDescriptor, paddle.nn.Layer):
9494
Not supported yet in Paddle.
9595
type_map : list[str], Optional
9696
A list of strings. Give the name to each type of atoms.
97+
98+
References
99+
----------
100+
.. [1] Zhang, D., Peng, A., Cai, C. et al. Graph neural
101+
network model for the era of large atomistic models.
102+
arXiv preprint arXiv:2506.01686 (2025).
97103
"""
98104

99105
def __init__(

deepmd/pt/model/descriptor/dpa3.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363

6464
@BaseDescriptor.register("dpa3")
6565
class DescrptDPA3(BaseDescriptor, torch.nn.Module):
66-
r"""The DPA-3 descriptor.
66+
r"""The DPA-3 descriptor[1]_.
6767
6868
Parameters
6969
----------
@@ -94,6 +94,12 @@ class DescrptDPA3(BaseDescriptor, torch.nn.Module):
9494
When True, local indexing and mapping are applied to neighbor lists and embeddings during descriptor computation.
9595
type_map : list[str], Optional
9696
A list of strings. Give the name to each type of atoms.
97+
98+
References
99+
----------
100+
.. [1] Zhang, D., Peng, A., Cai, C. et al. Graph neural
101+
network model for the era of large atomistic models.
102+
arXiv preprint arXiv:2506.01686 (2025).
97103
"""
98104

99105
def __init__(

doc/model/dpa3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Its model design ensures exceptional fitting accuracy and robust generalization
1111
Furthermore, DPA-3 maintains energy conservation and respects the physical symmetries of the potential energy surface,
1212
making it a dependable tool for a wide range of scientific applications.
1313

14-
Reference: will be released soon.
14+
Reference: [DPA-3 paper](https://arxiv.org/abs/2506.01686).
1515

1616
Training example: `examples/water/dpa3/input_torch.json`.
1717

0 commit comments

Comments
 (0)