Skip to content

modify doc for in_dygraph_mode #27620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wanghuancoder wants to merge 1 commit into from
Closed

modify doc for in_dygraph_mode #27620

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 9 additions & 12 deletions python/paddle/fluid/framework.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,27 +180,24 @@ def version_cmp(ver_a, ver_b):

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 .
Starting with paddle2.0, the dynamic graph mode the default mode.

**Note**:
``paddle.in_dynamic_mode`` is the alias of ``fluid.in_dygraph_mode``, and
``paddle.in_dynamic_mode`` is recommended to use.

Returns:
bool: Whether the program is running in dynamic graph mode.

Examples:
.. code-block:: python

import paddle.fluid as fluid
import paddle

fluid.enable_dygraph() # Now we are in dygragh mode
print(fluid.in_dygraph_mode()) # True
fluid.disable_dygraph()
print(fluid.in_dygraph_mode()) # False
print(paddle.in_dynamic_mode()) # True
paddle.enable_static()
print(paddle.in_dynamic_mode()) # False
"""
return _dygraph_tracer_ is not None

Expand Down