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

Jump to bottom

Fixed the dead link bug in the API documentation #48969

Merged
merged 8 commits into from
Dec 13, 2022
Merged

Fixed the dead link bug in the API documentation #48969

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fc16786
first pr
jjyaoao Dec 9, 2022
35b72b3
Revise nn.py
jjyaoao Dec 12, 2022
264d961
Revise nn.py 2.0
jjyaoao Dec 12, 2022
716002e
Revise nn.py 2.0
jjyaoao Dec 12, 2022
f006c3c
Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into…
jjyaoao Dec 12, 2022
6568bcc
Revise rnn.py;test=document_fix
jjyaoao Dec 12, 2022
11f10ff
Merge branch 'develop' into my-cool-stuff
Ligoml Dec 13, 2022
2ddf4c4
test=document_fix
Ligoml Dec 13, 2022
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
2 changes: 1 addition & 1 deletion python/paddle/distributed/launch/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def launch():


Base Parameters:
- ``--master``: The master/rendezvous server, support http:// and etcd://, default with http://. e.g., ``--master=127.0.0.1:8080``. Default ``--master=None``.
- ``--master``: The master/rendezvous server, support ``http://`` and ``etcd://``, default with ``http://``. e.g., ``--master=127.0.0.1:8080``. Default ``--master=None``.

- ``--rank``: The rank of the node, can be auto assigned by master. Default ``--rank=-1``.

Expand Down
1 change: 1 addition & 0 deletions python/paddle/fluid/dygraph/nn.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
check_type,
check_dtype,
)

from ..param_attr import ParamAttr
from ..initializer import Normal, Constant, NumpyArrayInitializer
from .. import unique_name
Expand Down
12 changes: 6 additions & 6 deletions python/paddle/fluid/framework.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1384,7 +1384,7 @@ class Variable(metaclass=VariableMetaClass):
shape=[-1, 23, 48],
dtype='float32')

In `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ Mode:
In Dygraph Mode:

.. code-block:: python

Expand Down Expand Up @@ -1861,7 +1861,7 @@ def stop_gradient(self):
"""
Indicating if we stop gradient from current Variable

**Notes: This Property has default value as** ``True`` **in** `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ **mode, while Parameter's default value is False. However, in Static Graph Mode all Variable's default stop_gradient value is** ``False``
**Notes: This Property has default value as** ``True`` **in** Dygraph **mode, while Parameter's default value is False. However, in Static Graph Mode all Variable's default stop_gradient value is** ``False``

Examples:
.. code-block:: python
Expand Down Expand Up @@ -1903,7 +1903,7 @@ def persistable(self):

**1. All Variable's persistable is** ``False`` **except Parameters.**

**2. In** `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ **mode, this property should not be changed**
**2. In** Dygraph **mode, this property should not be changed**

Examples:
.. code-block:: python
Expand Down Expand Up @@ -1952,7 +1952,7 @@ def name(self):
"""
Indicating name of current Variable

**Notes: If it has two or more Varaible share the same name in the same** :ref:`api_guide_Block_en` **, it means these Variable will share content in no-** `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ **mode. This is how we achieve Parameter sharing**
**Notes: If it has two or more Varaible share the same name in the same** :ref:`api_guide_Block_en` **, it means these Variable will share content in no-** Dygraph **mode. This is how we achieve Parameter sharing**

Examples:
.. code-block:: python
Expand Down Expand Up @@ -1982,7 +1982,7 @@ def grad_name(self):
import paddle.fluid as fluid

x = fluid.data(name="x", shape=[-1, 23, 48], dtype='float32')
print(x.grad_name) # output is "x@GRAD"
print(x.grad_name) # output is ``x@GRAD``

"""
return self.name + "@GRAD"
Expand Down Expand Up @@ -2043,7 +2043,7 @@ def lod_level(self):

**1. This is a read-only property**

**2. Don't support this property in** `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ **mode, it's value should be** ``0(int)``
**2. Don't support this property in** Dygraph **mode, it's value should be** ``0(int)``

Examples:
.. code-block:: python
Expand Down
11 changes: 1 addition & 10 deletions python/paddle/fluid/layers/rnn.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@

class RNNCell:
"""
:api_attr: Static Graph

RNNCell is the base class for abstraction representing the calculations
mapping the input and state to the output and new state. It is suitable to
Expand Down Expand Up @@ -217,7 +216,6 @@ def state_dtype(self):

class GRUCell(RNNCell):
r"""
:api_attr: Static Graph

Gated Recurrent Unit cell. It is a wrapper for
`fluid.contrib.layers.rnn_impl.BasicGRUUnit` to make it adapt to RNNCell.
Expand Down Expand Up @@ -326,7 +324,6 @@ def state_shape(self):

class LSTMCell(RNNCell):
r"""
:api_attr: Static Graph

Long-Short Term Memory cell. It is a wrapper for
`fluid.contrib.layers.rnn_impl.BasicLSTMUnit` to make it adapt to RNNCell.
Expand Down Expand Up @@ -1249,7 +1246,6 @@ def dynamic_lstm(
name=None,
):
r"""
:api_attr: Static Graph

**Note**:
1. This OP only supports LoDTensor as inputs. If you need to deal with Tensor, please use :ref:`api_fluid_layers_lstm` .
Expand Down Expand Up @@ -1439,12 +1435,11 @@ def lstm(
seed=-1,
):
r"""
:api_attr: Static Graph

**Note**:
This OP only supports running on GPU devices.

This OP implements LSTM operation - `Hochreiter, S., & Schmidhuber, J. (1997) <http://deeplearning.cs.cmu.edu/pdfs/Hochreiter97_lstm.pdf>`_ .
This OP implements LSTM operation - `Hochreiter, S., & Schmidhuber, J. (1997) <https://blog.xpgreat.com/file/lstm.pdf>`_ .

The implementation of this OP does not include diagonal/peephole connections.
Please refer to `Gers, F. A., & Schmidhuber, J. (2000) <ftp://ftp.idsia.ch/pub/juergen/TimeCount-IJCNN2000.pdf>`_ .
Expand Down Expand Up @@ -1630,7 +1625,6 @@ def dynamic_lstmp(
proj_clip=None,
):
r"""
:api_attr: Static Graph

**Note**:
1. In order to improve efficiency, users must first map the input of dimension [T, hidden_size] to input of [T, 4 * hidden_size], and then pass it to this OP.
Expand Down Expand Up @@ -1855,7 +1849,6 @@ def dynamic_gru(
origin_mode=False,
):
r"""
:api_attr: Static Graph

**Note: The input type of this must be LoDTensor. If the input type to be
processed is Tensor, use** :ref:`api_fluid_layers_StaticRNN` .
Expand Down Expand Up @@ -2025,7 +2018,6 @@ def gru_unit(
origin_mode=False,
):
r"""
:api_attr: Static Graph

Gated Recurrent Unit (GRU) RNN cell. This operator performs GRU calculations for
one time step and it supports these two modes:
Expand Down Expand Up @@ -2187,7 +2179,6 @@ def lstm_unit(
name=None,
):
r"""
:api_attr: Static Graph

Long-Short Term Memory (LSTM) RNN cell. This operator performs LSTM calculations for
one time step, whose implementation is based on calculations described in `RECURRENT
Expand Down