From af186d6f9108ec8b26289226526958e5ce45e19a Mon Sep 17 00:00:00 2001 From: yangxiaoyu14 Date: Thu, 24 Aug 2023 08:06:20 +0000 Subject: [PATCH 1/3] add_dtensor_from_fn_cn_doc --- docs/api/api_label | 1 + .../paddle/distributed/dtensor_from_fn_cn.rst | 28 +++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 docs/api/paddle/distributed/dtensor_from_fn_cn.rst diff --git a/docs/api/api_label b/docs/api/api_label index 2f54a29900a..d6a544e6a39 100644 --- a/docs/api/api_label +++ b/docs/api/api_label @@ -47,6 +47,7 @@ paddle.distributed.get_group .. _api_paddle_distributed_get_group: paddle.distributed.ReduceOp .. _api_paddle_distributed_ReduceOp: paddle.distributed.DistAttr .. _api_distributed_DistAttr: paddle.distributed.shard_tensor .. _api_distributed_shard_tensor: +paddle.distributed.dtensor_from_fn .. _api_distributed_dtensor_from_fn: paddle.distributed.fleet.UserDefinedRoleMaker .. _api_paddle_distributed_fleet_UserDefinedRoleMaker: paddle.distributed.fleet.Role .. _api_paddle_distributed_fleet_Role: paddle.distributed.fleet.HybridCommunicateGroup .. _api_paddle_distributed_fleet_HybridCommunicateGroup: diff --git a/docs/api/paddle/distributed/dtensor_from_fn_cn.rst b/docs/api/paddle/distributed/dtensor_from_fn_cn.rst new file mode 100644 index 00000000000..d730a3e1caf --- /dev/null +++ b/docs/api/paddle/distributed/dtensor_from_fn_cn.rst @@ -0,0 +1,28 @@ +.. _cn_api_distributed_dtensor_from_fn: + +dtensor_from_fn +------------------------------- + +.. py:class:: paddle.distributed.dtensor_from_fn(fn,dist_attr,*args,**kwargs) + +通过传入的函数fn以及可能的参数*args,**kwargs构造一个tensor,将这个tensor传给shard_tensor + + +参数 +::::::::: + + - **fn** - 类似empty/ones/zeros等任意函数 + - **dist_attr** (paddle.distributed.DistAttr) - 描述 Tensor 在 ProcessMesh 上的分布或切片方式。 + - ***args** - fn函数可能存在的参数 + - ****kwargs** - fn函数可能存在的参数 + + +返回 +::::::::: +带有分布式信息的 Tensor + + + +**代码示例** + +COPY-FROM: paddle.distributed.dtensor_from_fn From 4da32575573ddc85850dca5db7ef7cbd16b87c81 Mon Sep 17 00:00:00 2001 From: yangxiaoyu14 Date: Fri, 25 Aug 2023 07:25:34 +0000 Subject: [PATCH 2/3] resolve issues raised by code review --- docs/api/paddle/distributed/dtensor_from_fn_cn.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/api/paddle/distributed/dtensor_from_fn_cn.rst b/docs/api/paddle/distributed/dtensor_from_fn_cn.rst index d730a3e1caf..d2af6bb2755 100644 --- a/docs/api/paddle/distributed/dtensor_from_fn_cn.rst +++ b/docs/api/paddle/distributed/dtensor_from_fn_cn.rst @@ -3,18 +3,20 @@ dtensor_from_fn ------------------------------- -.. py:class:: paddle.distributed.dtensor_from_fn(fn,dist_attr,*args,**kwargs) - -通过传入的函数fn以及可能的参数*args,**kwargs构造一个tensor,将这个tensor传给shard_tensor +.. py:class:: paddle.distributed.dtensor_from_fn(fn, dist_attr, *args, **kwargs) +通过一个paddle API(一般是Tensor创建类的API)结合分布式属性dist_attr创建一个带有分布式属性的Tensor。 参数 ::::::::: - - **fn** - 类似empty/ones/zeros等任意函数 + - **fn** - paddle公开的可创建Tensor的API。例如:'paddle.empty'_、'paddle.ones'_、'paddle.zeros'_等paddle API + .. _paddle.empty:https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/tensor/creation.py + .. _paddle.ones:https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/tensor/creation.py + .. _paddle.zeros:https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/tensor/creation.py - **dist_attr** (paddle.distributed.DistAttr) - 描述 Tensor 在 ProcessMesh 上的分布或切片方式。 - - ***args** - fn函数可能存在的参数 - - ****kwargs** - fn函数可能存在的参数 + - ***args** - fn函数的输入参数(Tuple形式) + - ****kwargs** - fn函数的输入参数(Dict形式) 返回 From a17bed7fd0f99e70bf56cb83515acf0b8c2212fa Mon Sep 17 00:00:00 2001 From: yangxiaoyu14 Date: Mon, 28 Aug 2023 06:38:38 +0000 Subject: [PATCH 3/3] fix rst grammar bugs --- docs/api/paddle/distributed/dtensor_from_fn_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/distributed/dtensor_from_fn_cn.rst b/docs/api/paddle/distributed/dtensor_from_fn_cn.rst index d2af6bb2755..6bcf68e1021 100644 --- a/docs/api/paddle/distributed/dtensor_from_fn_cn.rst +++ b/docs/api/paddle/distributed/dtensor_from_fn_cn.rst @@ -10,7 +10,7 @@ dtensor_from_fn 参数 ::::::::: - - **fn** - paddle公开的可创建Tensor的API。例如:'paddle.empty'_、'paddle.ones'_、'paddle.zeros'_等paddle API + - **fn** - paddle公开的可创建Tensor的API。例如:`paddle.empty`_、`paddle.ones`_、`paddle.zeros`_等paddle API .. _paddle.empty:https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/tensor/creation.py .. _paddle.ones:https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/tensor/creation.py .. _paddle.zeros:https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/tensor/creation.py