update dygraph auto_parallel en API docs. #59557

wuhuachaocoding · 2023-11-30T08:07:50Z

PR types

Others

PR changes

Docs

Description

update dygraph auto_parallel en API docs.
Pcard-73145

sunzhongkai588 · 2023-12-01T08:01:45Z

paddle/fluid/pybind/auto_parallel_py.cc

+        ReduceType.kRedSum
+        ReduceType.kRedMax
+        ReduceType.kRedMin
+        ReduceType.kRedProd
+        ReduceType.kRedAvg
+        ReduceType.kRedAny
+        ReduceType.kRedAll


改成一行行的段落吧，美观点

Suggested change

ReduceType.kRedSum

ReduceType.kRedMax

ReduceType.kRedMin

ReduceType.kRedProd

ReduceType.kRedAvg

ReduceType.kRedAny

ReduceType.kRedAll

- ReduceType.kRedSum

- ReduceType.kRedMax

- ReduceType.kRedMin

- ReduceType.kRedProd

- ReduceType.kRedAvg

- ReduceType.kRedAny

- ReduceType.kRedAll

sunzhongkai588 · 2023-12-01T08:03:49Z

paddle/fluid/pybind/auto_parallel_py.cc

+    Examples:
+        .. code-block:: python
+
+        >>> import paddle
+        >>> import paddle.distributed as dist
+        >>> mesh = dist.ProcessMesh([0, 1], dim_names=["x"])
+        >>> a = paddle.ones([10, 20])
+        >>> # doctest: +REQUIRES(env:DISTRIBUTED)
+        >>> # distributed tensor
+        >>> d_tensor = dist.shard_tensor(a, mesh, [dist.Partial(dist.ReduceType.kRedSum)])


Examples、.. code-block:: python 和代码片段层层都得保持缩进，参考 API文档英文模板，不然网页渲染会不正常。

Suggested change

Examples:

.. code-block:: python

>>> import paddle

>>> import paddle.distributed as dist

>>> mesh = dist.ProcessMesh([0, 1], dim_names=["x"])

>>> a = paddle.ones([10, 20])

>>> # doctest: +REQUIRES(env:DISTRIBUTED)

>>> # distributed tensor

>>> d_tensor = dist.shard_tensor(a, mesh, [dist.Partial(dist.ReduceType.kRedSum)])

Examples:

.. code-block:: python

>>> import paddle

>>> import paddle.distributed as dist

>>> mesh = dist.ProcessMesh([0, 1], dim_names=["x"])

>>> a = paddle.ones([10, 20])

>>> # doctest: +REQUIRES(env:DISTRIBUTED)

>>> # distributed tensor

>>> d_tensor = dist.shard_tensor(a, mesh, [dist.Partial(dist.ReduceType.kRedSum)])

sunzhongkai588 · 2023-12-01T08:07:34Z

paddle/fluid/pybind/auto_parallel_py.cc

+        Examples:
+        .. code-block:: python
+
+        >>> import paddle.distributed as dist
+        >>> placements = [dist.Replicate(), dist.Shard(0), dist.Partial()]
+        >>> for p in placements:
+        >>>     if isinstance(p, dist.Placement):
+        >>>         if p.is_replicated():
+        >>>             print("replicate.")
+        >>>         elif p.is_shard():
+        >>>             print("shard.")
+        >>>         elif p.is_partial():
+        >>>             print("partial.")


同理，需要缩进

Suggested change

Examples:

.. code-block:: python

>>> import paddle.distributed as dist

>>> placements = [dist.Replicate(), dist.Shard(0), dist.Partial()]

>>> for p in placements:

>>> if isinstance(p, dist.Placement):

>>> if p.is_replicated():

>>> print("replicate.")

>>> elif p.is_shard():

>>> print("shard.")

>>> elif p.is_partial():

>>> print("partial.")

Examples:

.. code-block:: python

>>> import paddle.distributed as dist

>>> placements = [dist.Replicate(), dist.Shard(0), dist.Partial()]

>>> for p in placements:

>>> if isinstance(p, dist.Placement):

>>> if p.is_replicated():

>>> print("replicate.")

>>> elif p.is_shard():

>>> print("shard.")

>>> elif p.is_partial():

>>> print("partial.")

sunzhongkai588 · 2023-12-01T08:10:23Z

paddle/fluid/pybind/auto_parallel_py.cc

+               Examples:
+               .. code-block:: python
+
+               >>> import paddle
+               >>> import paddle.distributed as dist
+               >>> mesh = dist.ProcessMesh([[2, 4, 5], [0, 1, 3]], dim_names=['x', 'y'])
+               >>> a = paddle.to_tensor([[1,2,3],[5,6,7]])
+               >>> # doctest: +REQUIRES(env:DISTRIBUTED)
+               >>> # distributed tensor
+               >>> d_tensor = dist.shard_tensor(a, mesh, [dist.Shard(0), dist.Shard(1)])


Suggested change

Examples:

.. code-block:: python

>>> import paddle

>>> import paddle.distributed as dist

>>> mesh = dist.ProcessMesh([[2, 4, 5], [0, 1, 3]], dim_names=['x', 'y'])

>>> a = paddle.to_tensor([[1,2,3],[5,6,7]])

>>> # doctest: +REQUIRES(env:DISTRIBUTED)

>>> # distributed tensor

>>> d_tensor = dist.shard_tensor(a, mesh, [dist.Shard(0), dist.Shard(1)])

Examples:

.. code-block:: python

>>> import paddle

>>> import paddle.distributed as dist

>>> mesh = dist.ProcessMesh([[2, 4, 5], [0, 1, 3]], dim_names=['x', 'y'])

>>> a = paddle.to_tensor([[1,2,3],[5,6,7]])

>>> # doctest: +REQUIRES(env:DISTRIBUTED)

>>> # distributed tensor

>>> d_tensor = dist.shard_tensor(a, mesh, [dist.Shard(0), dist.Shard(1)])

sunzhongkai588 · 2023-12-01T08:11:23Z

paddle/fluid/pybind/auto_parallel_py.cc

+                   Examples:
+                   .. code-block:: python
+
+                   >>> import paddle
+                   >>> import paddle.distributed as dist
+                   >>> mesh = dist.ProcessMesh([0, 1], dim_names=["x"])
+                   >>> a = paddle.ones([10, 20])
+                   >>> # doctest: +REQUIRES(env:DISTRIBUTED)
+                   >>> # distributed tensor
+                   >>> d_tensor = dist.shard_tensor(a, mesh, [dist.Replicate()])


Suggested change

Examples:

.. code-block:: python

>>> import paddle

>>> import paddle.distributed as dist

>>> mesh = dist.ProcessMesh([0, 1], dim_names=["x"])

>>> a = paddle.ones([10, 20])

>>> # doctest: +REQUIRES(env:DISTRIBUTED)

>>> # distributed tensor

>>> d_tensor = dist.shard_tensor(a, mesh, [dist.Replicate()])

Examples:

.. code-block:: python

>>> import paddle

>>> import paddle.distributed as dist

>>> mesh = dist.ProcessMesh([0, 1], dim_names=["x"])

>>> a = paddle.ones([10, 20])

>>> # doctest: +REQUIRES(env:DISTRIBUTED)

>>> # distributed tensor

>>> d_tensor = dist.shard_tensor(a, mesh, [dist.Replicate()])

sunzhongkai588 · 2023-12-01T08:12:55Z

paddle/fluid/pybind/auto_parallel_py.cc

+                 Examples:
+                 .. code-block:: python
+
+                 >>> import paddle
+                 >>> import paddle.distributed as dist
+                 >>> mesh = dist.ProcessMesh([0, 1], dim_names=["x"])
+                 >>> a = paddle.ones([10, 20])
+                 >>> # doctest: +REQUIRES(env:DISTRIBUTED)
+                 >>> # distributed tensor
+                 >>> d_tensor = dist.shard_tensor(a, mesh, [dist.Partial()])


Suggested change

Examples:

.. code-block:: python

>>> import paddle

>>> import paddle.distributed as dist

>>> mesh = dist.ProcessMesh([0, 1], dim_names=["x"])

>>> a = paddle.ones([10, 20])

>>> # doctest: +REQUIRES(env:DISTRIBUTED)

>>> # distributed tensor

>>> d_tensor = dist.shard_tensor(a, mesh, [dist.Partial()])

Examples:

.. code-block:: python

>>> import paddle

>>> import paddle.distributed as dist

>>> mesh = dist.ProcessMesh([0, 1], dim_names=["x"])

>>> a = paddle.ones([10, 20])

>>> # doctest: +REQUIRES(env:DISTRIBUTED)

>>> # distributed tensor

>>> d_tensor = dist.shard_tensor(a, mesh, [dist.Partial()])

sunzhongkai588

LGTM，同步提供下中文文档～

LiYuRio

LGTM

XiaoguangHu01

LGTM

sunzhongkai588 reviewed Dec 1, 2023

View reviewed changes

update dygraph auto_parallel en API docs.

52c30de

wuhuachaocoding force-pushed the dygraph_en_doc branch from a49397a to 52c30de Compare December 1, 2023 12:07

sunzhongkai588 approved these changes Dec 4, 2023

View reviewed changes

LiYuRio approved these changes Dec 4, 2023

View reviewed changes

XiaoguangHu01 approved these changes Dec 4, 2023

View reviewed changes

tianshuo78520a approved these changes Dec 4, 2023

View reviewed changes

LiYuRio merged commit 6577edb into PaddlePaddle:develop Dec 4, 2023

SigureMo pushed a commit to gouzil/Paddle that referenced this pull request Dec 5, 2023

update dygraph auto_parallel en API docs. (PaddlePaddle#59557)

097241d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update dygraph auto_parallel en API docs. #59557

update dygraph auto_parallel en API docs. #59557

wuhuachaocoding commented Nov 30, 2023

sunzhongkai588 Dec 1, 2023

wuhuachaocoding Dec 1, 2023

sunzhongkai588 Dec 1, 2023

wuhuachaocoding Dec 1, 2023

sunzhongkai588 Dec 1, 2023

wuhuachaocoding Dec 1, 2023

sunzhongkai588 Dec 1, 2023

wuhuachaocoding Dec 1, 2023

sunzhongkai588 Dec 1, 2023

wuhuachaocoding Dec 1, 2023

sunzhongkai588 Dec 1, 2023

wuhuachaocoding Dec 1, 2023

sunzhongkai588 left a comment •

edited

Loading

LiYuRio left a comment

XiaoguangHu01 left a comment

update dygraph auto_parallel en API docs. #59557

update dygraph auto_parallel en API docs. #59557

Conversation

wuhuachaocoding commented Nov 30, 2023

PR types

PR changes

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunzhongkai588 left a comment • edited Loading

Choose a reason for hiding this comment

LiYuRio left a comment

Choose a reason for hiding this comment

XiaoguangHu01 left a comment

Choose a reason for hiding this comment

sunzhongkai588 left a comment •

edited

Loading