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

fix the document format of enable_prim/disable_prim/prim2orig/prim_enabled
0x45f · May 17, 2022 · d797c21 · d797c21
2 parents b616351 + 368e9a7
commit d797c21
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 10 deletions.
diff --git a/python/paddle/incubate/autograd/primx.py b/python/paddle/incubate/autograd/primx.py
@@ -537,15 +537,15 @@ def orig2prim(block=None):
 def prim2orig(block=None):
     """
     .. note::
-        **This API is ONLY available in the static mode.**
+        **ONLY available in the static mode.**
 
     All operators in the target block are processed as follows.
     If it is an automatic differential basic operator, it will be
     transformed into one or a series of original operators with
     equivalent function to support execution.
     
     Args:
-        block(paddle.fluid.framework.Variable|None, optional): The
+        block(paddle.static.Variable|None, optional): The
             target block to process on. Default None, and will
             process on the current block of main program.
        

diff --git a/python/paddle/incubate/autograd/utils.py b/python/paddle/incubate/autograd/utils.py
@@ -34,14 +34,13 @@ def set_status(self, flag):
 def prim_enabled():
     """
     .. note::
-        **This API is ONLY available in the static mode.**
+        **ONLY available in the static mode.**
 
-    This API shows whether the automatic differentiation mechanism based on 
+    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. Defaults to False.
 
     Examples:
 
@@ -66,9 +65,9 @@ def prim_enabled():
 def enable_prim():
     """
     .. note::
-        **This API is ONLY available in the static mode.**
+        **ONLY available in the static mode.**
 
-    This API turns ON automatic differentiation mechanism based on automatic 
+    Turns ON automatic differentiation mechanism based on automatic 
     differential basic operators.
     
     Examples:
@@ -90,9 +89,9 @@ def enable_prim():
 def disable_prim():
     """
     .. note::
-        **This API is ONLY available in the static mode.**
+        **ONLY available in the static mode.**
 
-    This API turns OFF automatic differentiation mechanism based on automatic 
+    Turns OFF automatic differentiation mechanism based on automatic 
     differential basic operators.
     
     Examples: