Merge pull request #11531 from reyoung/feature/non_layer_api_doc

Polish Non-Layer API

python/paddle/fluid/__init__.py

@@ -44,7 +44,7 @@
 import transpiler
 from param_attr import ParamAttr, WeightNormParamAttr
 from data_feeder import DataFeeder
-from core import LoDTensor, CPUPlace, CUDAPlace, CUDAPinnedPlace
+from core import LoDTensor, CPUPlace, CUDAPlace, CUDAPinnedPlace, Scope
 from transpiler import DistributeTranspiler, InferenceTranspiler, \
  memory_optimize, release_memory
 from concurrency import (Go, make_channel, channel_send, channel_recv,
@@ -83,6 +83,7 @@
  'profiler',
  'unique_name',
  'recordio_writer',
+ 'Scope',
  ]
 
 

python/paddle/fluid/executor.py

@@ -25,6 +25,13 @@
 
 
 def global_scope():
+ """
+ Get the global/default scope instance. There are a lot of APIs use
+ :code:`global_scope` as its default value, e.g., :code:`Executor.run`
+
+ Returns:
+ Scope: The global/default scope instance.
+ """
  return g_scope
 
 
@@ -37,6 +44,19 @@ def switch_scope(scope):
 
 @contextlib.contextmanager
 def scope_guard(scope):
+ """
+ Change the global/default scope instance by Python `with` statement. All
+ variable in runtime will assigned to the new scope.
+
+ Examples:
+ >>> import paddle.fluid as fluid
+ >>> new_scope = fluid.Scope()
+ >>> with fluid.scope_guard(new_scope):
+ >>> ...
+
+ Args:
+ scope: The new global/default scope.
+ """
  ex = switch_scope(scope)
  yield
  switch_scope(ex)