Merge pull request #3 from cxxly/science-add-rules-ut

update the format of english documents
PaddlePaddle · May 16, 2022 · 03256b4 · 03256b4 · paddle-bot-old · May 16, 2022
2 parents 06dd62d + a8b3bb1
commit 03256b4
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 25 deletions.
diff --git a/python/paddle/incubate/autograd/__init__.py b/python/paddle/incubate/autograd/__init__.py
@@ -16,5 +16,12 @@
 from .utils import enable_prim, disable_prim, prim_enabled
 
 __all__ = [  # noqa
-    'vjp', 'jvp', 'Jacobian', 'Hessian', 'prim2orig', 'enable_prim', 'disable_prim', 'prim_enabled'
+    'vjp',
+    'jvp',
+    'Jacobian',
+    'Hessian',
+    'prim2orig',
+    'enable_prim',
+    'disable_prim',
+    'prim_enabled'
 ]
diff --git a/python/paddle/incubate/autograd/primx.py b/python/paddle/incubate/autograd/primx.py
@@ -548,10 +548,7 @@ def prim2orig(block=None):
         block(paddle.fluid.framework.Variable|None, optional): The
             target block to process on. Default None, and will
             process on the current block of main program.
-    
-    Returns:
-        None
-    
+       
     Examples:
 
         .. code-block:: python

diff --git a/python/paddle/incubate/autograd/utils.py b/python/paddle/incubate/autograd/utils.py
@@ -36,13 +36,12 @@ def prim_enabled():
     .. note::
         **This API is ONLY available in the static mode.**
 
-    This API shows whether the automatic differentiation mechanism based on automatic differential basic operators is ON.
-    
-    Args:
-        None
-    
+    This API shows whether the automatic differentiation mechanism based on 
+    automatic differential basic operators is ON.
+     
     Returns:
-        flag(bool): whether the automatic differentiation mechanism based on automatic differential basic operators is ON. 
+        flag(bool): whether the automatic differentiation mechanism based on 
+            automatic differential basic operators is ON. 
 
     Examples:
 
@@ -69,14 +68,9 @@ def enable_prim():
     .. note::
         **This API is ONLY available in the static mode.**
 
-    This API turns ON automatic differentiation mechanism based on automatic differential basic operators.
+    This API turns ON automatic differentiation mechanism based on automatic 
+    differential basic operators.
     
-    Args:
-        None
-    
-    Returns:
-        None
-
     Examples:
 
         .. code-block:: python
@@ -98,14 +92,9 @@ def disable_prim():
     .. note::
         **This API is ONLY available in the static mode.**
 
-    This API turns OFF automatic differentiation mechanism based on automatic differential basic operators.
-    
-    Args:
-        None
+    This API turns OFF automatic differentiation mechanism based on automatic 
+    differential basic operators.
     
-    Returns:
-        None
-
     Examples:
 
         .. code-block:: python