Skip to content
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

[xdoctest] reformat example code with google style No.241-245 #56359

Merged
merged 6 commits into from
Aug 25, 2023
Merged

[xdoctest] reformat example code with google style No.241-245 #56359

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
498d4ea
fix: refine code examples
PommesPeter Aug 11, 2023
8794cab
fix: refine detail
PommesPeter Aug 16, 2023
403205c
refactor: refine detail
PommesPeter Aug 17, 2023
4e5229f
refactor: refine detail
PommesPeter Aug 17, 2023
fdc187e
fix: refine code style.
PommesPeter Aug 22, 2023
ac966aa
Update python/paddle/incubate/autograd/functional.py
SigureMo Aug 24, 2023
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
Prev Previous commit
Next Next commit
fix: refine detail
  • Loading branch information
@PommesPeter
PommesPeter committed Aug 16, 2023
commit 8794cab34d33c795f5974eb4247ae0783beb7c8e
16 changes: 12 additions & 4 deletions python/paddle/incubate/autograd/primreg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ def op_position_inputs(op):
>>> from paddle.fluid.layer_helper import LayerHelper
>>> from paddle.incubate.autograd.primreg import REGISTER_FN

>>> # doctest: +SKIP('Depends on external files.')
>>> @REGISTER_FN('div_p', 'X', 'Y', 'Z')
>>> def div(x, y, out=None):
... return _simple_binop(LayerHelper('div_p', **locals()))
Expand Down Expand Up @@ -122,14 +123,15 @@ def op_position_output(op):
Examples:
.. code-block:: python

>>> # doctest: +SKIP('Depends on external files.')
>>> from paddle.incubate.autograd.primops import _simple_binop
>>> from paddle.fluid.layer_helper import LayerHelper
>>> from paddle.incubate.autograd.primreg import REGISTER_FN

>>> @REGISTER_FN('div_p', 'X', 'Y', 'Z')
>>> def div(x, y, out=None):
... return _simple_binop(LayerHelper('div_p', **locals()))
...
...
The registered output is ['Z'] for div_p and accordingly this
function will return output Z.

Expand Down Expand Up @@ -164,6 +166,7 @@ def REGISTER_FN(op_type, *position_argnames):
Examples:
.. code-block:: python

>>> # doctest: +SKIP('Depends on external files.')
>>> from paddle.incubate.autograd.primops import _simple_binop
>>> from paddle.fluid.layer_helper import LayerHelper
>>> from paddle.incubate.autograd.primreg import REGISTER_FN
Expand Down Expand Up @@ -199,6 +202,7 @@ def REGISTER_ORIG2PRIM(op_type):
Examples:
.. code-block:: python

>>> # doctest: +SKIP('Depends on external files.')
>>> from paddle.fluid.layer_helper import LayerHelper
>>> from paddle.incubate.autograd.utils import get_input_var_list
>>> from paddle.incubate.autograd import primops
Expand Down Expand Up @@ -238,6 +242,7 @@ def REGISTER_COMPOSITE(op_type):
Examples:
.. code-block:: python

>>> # doctest: +SKIP('Depends on external files.')
>>> import paddle
>>> from paddle.incubate.autograd.primreg import REGISTER_COMPOSITE

Expand Down Expand Up @@ -277,6 +282,7 @@ def REGISTER_PRIM2ORIG(op_type):
Examples:
.. code-block:: python

>>> # doctest: +SKIP('Depends on external files.')
>>> import paddle
>>> from paddle.incubate.autograd.primreg import REGISTER_PRIM2ORIG
>>> from paddle.incubate.autograd.utils import get_input_var_list
Expand All @@ -285,7 +291,7 @@ def REGISTER_PRIM2ORIG(op_type):
>>> def tanh_prim2orig(op):
... x, = get_input_var_list(op)
... return paddle.tanh(x)
...
...
"""
if not isinstance(op_type, str):
raise TypeError(f'op_type must be str, but got {type(op_type)}.')
Expand Down Expand Up @@ -315,13 +321,14 @@ def REGISTER_JVP(op_type):
Examples:
.. code-block:: python

>>> # doctest: +SKIP('Depends on external files.')
>>> from paddle.incubate.autograd import primops
>>> from paddle.incubate.autograd.primreg import REGISTER_JVP

>>> @REGISTER_JVP('add_p')
>>> def add_jvp(op, x_dot, y_dot):
... return primops.add(x_dot, y_dot)
...
...
"""
if not isinstance(op_type, str):
raise TypeError(f'op_type must be str, but got {type(op_type)}.')
Expand Down Expand Up @@ -353,12 +360,13 @@ def REGISTER_TRANSPOSE(op_type):
Examples:
.. code-block:: python

>>> # doctest: +SKIP('Depends on external files.')
>>> from paddle.incubate.autograd.primreg import REGISTER_TRANSPOSE

>>> @REGISTER_TRANSPOSE('add_p')
>>> def add_transpose(op, z_bar):
... return z_bar, z_bar
...
...
"""
if not isinstance(op_type, str):
raise TypeError(f'op_type must be str, but got {type(op_type)}.')
Expand Down
18 changes: 13 additions & 5 deletions python/paddle/incubate/autograd/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,14 @@ def prim_enabled():
>>> paddle.enable_static()
>>> enable_prim()

>>> print(prim_enabled()) # True
>>> print(prim_enabled())
True

>>> disable_prim()

>>> print(prim_enabled()) # False
>>> print(prim_enabled())
False

"""
return prim_option.get_status()

Expand All @@ -84,7 +87,9 @@ def enable_prim():
>>> paddle.enable_static()
>>> enable_prim()

>>> print(prim_enabled()) # True
>>> print(prim_enabled())
True

"""
prim_option.set_status(True)

Expand All @@ -108,11 +113,14 @@ def disable_prim():
>>> paddle.enable_static()
>>> enable_prim()

>>> print(prim_enabled()) # True
>>> print(prim_enabled())
True

>>> disable_prim()

>>> print(prim_enabled()) # False
>>> print(prim_enabled())
False

"""
prim_option.set_status(False)

Expand Down