update docstring

Co-authored-by: Han Wang <92130845+wanghan-iapcm@users.noreply.github.com> Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
deepmodeling · Mar 1, 2024 · 2d501d9 · 2d501d9
1 parent 426d1cf
commit 2d501d9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/deepmd/dpmodel/fitting/general_fitting.py b/deepmd/dpmodel/fitting/general_fitting.py
@@ -75,8 +75,8 @@ class GeneralFitting(NativeOP, BaseFitting):
             Atomic contributions of the excluded atom types are set zero.
     remove_vaccum_contribution: List[bool], optional
         Remove vaccum contribution before the bias is added. The list assigned each
-        type. If not mixed_types, only remove the vaccum contribution for the atom types
-        in the list.
+        type. For `mixed_types` provide `[True]`, otherwise it should be a list of the same
+        length as `ntypes` signaling if or not removing the vaccum contribution for the atom types in the list.
     """
 
     def __init__(

diff --git a/deepmd/pt/model/task/fitting.py b/deepmd/pt/model/task/fitting.py
@@ -248,8 +248,8 @@ class GeneralFitting(Fitting):
         Atomic contributions of the excluded atom types are set zero.
     remove_vaccum_contribution: List[bool], optional
         Remove vaccum contribution before the bias is added. The list assigned each
-        type. If not mixed_types, only remove the vaccum contribution for the atom types
-        in the list.
+        type. For `mixed_types` provide `[True]`, otherwise it should be a list of the same
+        length as `ntypes` signaling if or not removing the vaccum contribution for the atom types in the list.
     """
 
     def __init__(