Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifiy se_atten_v2 compression doc #3727

Merged
merged 2 commits into from
May 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion deepmd/utils/argcheck.py
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ def descrpt_se_atten_common_args():
+ "The excluded pairs of types which have no interaction with each other. For example, `[[0, 1]]` means no interaction between type 0 and type 1."
)
doc_attn = "The length of hidden vectors in attention layers"
doc_attn_layer = "The number of attention layers. Note that model compression of `se_atten` is only enabled when attn_layer==0 and stripped_type_embedding is True"
doc_attn_layer = "The number of attention layers."
doc_attn_dotr = "Whether to do dot product with the normalized relative coordinates"
doc_attn_mask = "Whether to do mask on the diagonal in the attention matrix"

Expand Down
2 changes: 2 additions & 0 deletions doc/freeze/compress.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ The model compression interface requires the version of DeePMD-kit used in the o

Descriptors with `se_e2_a`, `se_e3`, `se_e2_r` and `se_atten_v2` types are supported by the model compression feature. `Hybrid` mixed with the above descriptors is also supported.

Notice: Model compression for the `se_atten_v2` descriptor is exclusively designed for models with the training parameter {ref}`attn_layer <model/descriptor[se_atten_v2]/attn_layer>` set to 0.

**Available activation functions for descriptor:**

- tanh
Expand Down
2 changes: 2 additions & 0 deletions doc/model/train-se-atten.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,8 @@ We highly recommend using the version 2.0 of the attention-based descriptor `"se

Practical evidence demonstrates that `"se_atten_v2"` offers better and more stable performance compared to `"se_atten"`.

Notice: Model compression for the `se_atten_v2` descriptor is exclusively designed for models with the training parameter {ref}`attn_layer <model/descriptor[se_atten_v2]/attn_layer>` set to 0.

### Fitting `"ener"`

DPA-1 only supports `"ener"` fitting type, and you can refer [here](train-energy.md) for detailed information.
Expand Down