Skip to content

Commit

Permalink
update the docstr
Browse files Browse the repository at this point in the history
  • Loading branch information
iProzd committed May 6, 2024
1 parent 3a98a65 commit b32c4f3
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 11 deletions.
8 changes: 5 additions & 3 deletions deepmd/dpmodel/descriptor/dpa1.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,9 +184,11 @@ class DescrptDPA1(NativeOP, BaseDescriptor):
concat_output_tebd: bool
Whether to concat type embedding at the output of the descriptor.
stripped_type_embedding: bool, Optional
(Deprecated, kept only for compatibility.)
Whether to strip the type embedding into a separated embedding network.
Setting this to `True` is equivalent to setting `tebd_input_mode` to 'strip'.
(Deprecated, kept only for compatibility.)
Whether to strip the type embedding into a separate embedding network.
Setting this parameter to `True` is equivalent to setting `tebd_input_mode` to 'strip'.
Setting it to `False` is equivalent to setting `tebd_input_mode` to 'concat'.
The default value is `None`, which means the `tebd_input_mode` setting will be used instead.
spin
(Only support None to keep consistent with other backend references.)
(Not used in this version. Not-none option is not implemented.)
Expand Down
8 changes: 5 additions & 3 deletions deepmd/pt/model/descriptor/dpa1.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,11 @@ class DescrptDPA1(BaseDescriptor, torch.nn.Module):
concat_output_tebd: bool
Whether to concat type embedding at the output of the descriptor.
stripped_type_embedding: bool, Optional
(Deprecated, kept only for compatibility.)
Whether to strip the type embedding into a separated embedding network.
Setting this to `True` is equivalent to setting `tebd_input_mode` to 'strip'.
(Deprecated, kept only for compatibility.)
Whether to strip the type embedding into a separate embedding network.
Setting this parameter to `True` is equivalent to setting `tebd_input_mode` to 'strip'.
Setting it to `False` is equivalent to setting `tebd_input_mode` to 'concat'.
The default value is `None`, which means the `tebd_input_mode` setting will be used instead.
spin
(Only support None to keep consistent with other backend references.)
(Not used in this version. Not-none option is not implemented.)
Expand Down
8 changes: 5 additions & 3 deletions deepmd/tf/descriptor/se_atten.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,11 @@ class DescrptSeAtten(DescrptSeA):
to keep the network smooth, instead of setting `set_davg_zero` to be True.
Default value will be True in `se_atten_v2` descriptor.
stripped_type_embedding: bool, Optional
(Deprecated, kept only for compatibility.)
Whether to strip the type embedding into a separated embedding network.
Setting this to `True` is equivalent to setting `tebd_input_mode` to 'strip'.
(Deprecated, kept only for compatibility.)
Whether to strip the type embedding into a separate embedding network.
Setting this parameter to `True` is equivalent to setting `tebd_input_mode` to 'strip'.
Setting it to `False` is equivalent to setting `tebd_input_mode` to 'concat'.
The default value is `None`, which means the `tebd_input_mode` setting will be used instead.
Raises
------
Expand Down
6 changes: 4 additions & 2 deletions deepmd/utils/argcheck.py
Original file line number Diff line number Diff line change
Expand Up @@ -504,8 +504,10 @@ def descrpt_se_atten_args():
"The output is `out_ij = embeding_t(input_t) * embeding_s(r_ij) + embeding_s(r_ij)` for the pair-wise representation of atom i with neighbor j."
)
doc_stripped_type_embedding = (
"(Deprecated, kept only for compatibility.) Whether to strip the type embedding into a separated embedding network. "
"Setting this to `True` is equivalent to setting `tebd_input_mode` to 'strip'."
"(Deprecated, kept only for compatibility.) Whether to strip the type embedding into a separate embedding network. "
"Setting this parameter to `True` is equivalent to setting `tebd_input_mode` to 'strip'. "
"Setting it to `False` is equivalent to setting `tebd_input_mode` to 'concat'."
"The default value is `None`, which means the `tebd_input_mode` setting will be used instead."
)

return [
Expand Down

0 comments on commit b32c4f3

Please sign in to comment.