fix: descriptor function doc (deepmodeling#2440)

Co-authored-by: AnuragKr <anuragkrsingh02@outlook.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
HPC-AI-Team · Apr 11, 2023 · 353a12b · 353a12b
1 parent 31c8a48
commit 353a12b
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/deepmd/descriptor/se_a.py b/deepmd/descriptor/se_a.py
@@ -273,7 +273,9 @@ def get_dim_rot_mat_1(self) -> int:
         return self.filter_neuron[-1]
 
     def get_nlist(self) -> Tuple[tf.Tensor, tf.Tensor, List[int], List[int]]:
-        """Returns
+        """Returns neighbor information.
+
+        Returns
         -------
         nlist
             Neighbor list

diff --git a/deepmd/descriptor/se_a_ef.py b/deepmd/descriptor/se_a_ef.py
@@ -140,7 +140,9 @@ def get_rot_mat(self) -> tf.Tensor:
         return self.qmat
 
     def get_nlist(self) -> Tuple[tf.Tensor, tf.Tensor, List[int], List[int]]:
-        """Returns
+        """Returns neighbor information.
+
+        Returns
         -------
         nlist
             Neighbor list

diff --git a/deepmd/descriptor/se_r.py b/deepmd/descriptor/se_r.py
@@ -190,7 +190,9 @@ def get_dim_out(self):
         return self.filter_neuron[-1]
 
     def get_nlist(self):
-        """Returns
+        """Returns neighbor information.
+
+        Returns
         -------
         nlist
             Neighbor list

diff --git a/deepmd/descriptor/se_t.py b/deepmd/descriptor/se_t.py
@@ -193,7 +193,9 @@ def get_dim_out(self) -> int:
         return self.filter_neuron[-1]
 
     def get_nlist(self) -> Tuple[tf.Tensor, tf.Tensor, List[int], List[int]]:
-        """Returns
+        """Returns neighbor information.
+
+        Returns
         -------
         nlist
             Neighbor list