diff --git a/python/paddle/fluid/dygraph/base.py b/python/paddle/fluid/dygraph/base.py index 69fb23383e5fc06da46d1791a056b6d8f4da8c52..9b540c378e9d3b0b8bb30f8c801bdad5016ce362 100644 --- a/python/paddle/fluid/dygraph/base.py +++ b/python/paddle/fluid/dygraph/base.py @@ -117,11 +117,15 @@ def enabled(): def enable_dygraph(place=None): """ - This function enables dynamic graph mode. + + .. note:: + Dynamic graph mode is turn ON by default since paddle 2.0.0 + + This API turn OFF static graph mode. You can turn ON static graph mode by `enable_static <./disable_dygraph_en.html>`_ . Parameters: - place(fluid.CPUPlace or fluid.CUDAPlace, optional): Place to execute dygraph. - If None, the running place will be determined according to the way of paddle compilation. Default: None + place(paddle.CPUPlace|paddle.CUDAPlace, optional): Place to run dynamic graph. Default: None. Which means that the running place will be + determined according to the way of paddle compilation. return: None @@ -129,12 +133,15 @@ def enable_dygraph(place=None): Examples: .. code-block:: python - import paddle.fluid as fluid + import paddle + print(paddle.in_dynamic_mode()) # True, dynamic mode is turn ON by default since paddle 2.0.0 + + paddle.enable_static() + print(paddle.in_dynamic_mode()) # False, Now we are in static mode + + paddle.disable_static() + print(paddle.in_dynamic_mode()) # True, Now we are in dynamic mode - fluid.enable_dygraph() # Now we are in dygragh mode - print(fluid.in_dygraph_mode()) # True - fluid.disable_dygraph() - print(fluid.in_dygraph_mode()) # False """ global _functional_dygraph_context_manager if _functional_dygraph_context_manager is None: @@ -147,7 +154,11 @@ def enable_dygraph(place=None): def disable_dygraph(): """ - This function disables dynamic graph mode. + + .. note:: + Dynamic graph mode is turn ON by default since paddle 2.0.0 + + This API turn ON static graph mode. You can turn ON static graph mode by `disable_static <./enable_dygraph_en.html>`_ . return: None @@ -155,12 +166,15 @@ def disable_dygraph(): Examples: .. code-block:: python - import paddle.fluid as fluid + import paddle + print(paddle.in_dynamic_mode()) # True, dynamic mode is turn ON by default since paddle 2.0.0 + + paddle.enable_static() + print(paddle.in_dynamic_mode()) # False, Now we are in static mode + + paddle.disable_static() + print(paddle.in_dynamic_mode()) # True, Now we are in dynamic mode - fluid.enable_dygraph() # Now we are in dygragh mode - print(fluid.in_dygraph_mode()) # True - fluid.disable_dygraph() - print(fluid.in_dygraph_mode()) # False """ global _functional_dygraph_context_manager if _functional_dygraph_context_manager is not None: diff --git a/python/paddle/fluid/framework.py b/python/paddle/fluid/framework.py index d4a4b135cdb5c6d9d25b564661289892e3f57339..efd15c193ac23b041e87516e516a8f0b84b48d13 100644 --- a/python/paddle/fluid/framework.py +++ b/python/paddle/fluid/framework.py @@ -180,27 +180,30 @@ def require_version(min_version, max_version=None): def in_dygraph_mode(): """ - :alias_main: paddle.in_dygraph_mode - :alias: paddle.in_dygraph_mode - :old_api: paddle.fluid.framework.in_dygraph_mode - This function checks whether the program runs in dynamic graph mode or not. - You can enter dynamic graph mode with :ref:`api_fluid_dygraph_guard` api, - or enable and disable dynamic graph mode with :ref:`api_fluid_dygraph_enable` - and :ref:`api_fluid_dygraph_disable` api . + .. note:: + Dynamic graph mode is turn ON by default since paddle 2.0.0 + + This API checks whether paddle runs in dynamic graph mode. + + You can turn ON static graph mode by `enable_static <../dygraph/base/disable_dygraph_en.html>`_ , + and turn OFF static graph mode by `disable_static <../dygraph/base/enable_dygraph_en.html>`_ . Returns: - bool: Whether the program is running in dynamic graph mode. + bool: Whether paddle runs in dynamic graph mode. Examples: .. code-block:: python - import paddle.fluid as fluid + import paddle + print(paddle.in_dynamic_mode()) # True, dynamic mode is turn ON by default since paddle 2.0.0 + + paddle.enable_static() + print(paddle.in_dynamic_mode()) # False, Now we are in static mode + + paddle.disable_static() + print(paddle.in_dynamic_mode()) # True, Now we are in dynamic mode - fluid.enable_dygraph() # Now we are in dygragh mode - print(fluid.in_dygraph_mode()) # True - fluid.disable_dygraph() - print(fluid.in_dygraph_mode()) # False """ return _dygraph_tracer_ is not None