add_dtensor_from_fn_cn_doc #6130
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chenwhql
reviewed
Aug 25, 2023
| dtensor_from_fn | ||
| ------------------------------- | ||
|
|
||
| .. py:class:: paddle.distributed.dtensor_from_fn(fn,dist_attr,*args,**kwargs) |
|
|
||
| .. py:class:: paddle.distributed.dtensor_from_fn(fn,dist_attr,*args,**kwargs) | ||
|
|
||
| 通过传入的函数fn以及可能的参数*args,**kwargs构造一个tensor，将这个tensor传给shard_tensor |
There was a problem hiding this comment.
这个描述是API的实现过程，我们这里重点描述API的功能，比如：通过的paddle API（一般是Tensor创建类API）结合分布式属性创建一个带有分布式属性的Tensor。具体可以再思考完善下
There was a problem hiding this comment.
参考修改为：通过一个paddle API(一般是Tensor创建类的API)结合分布式属性dist_attr创建一个带有分布式属性的Tensor。
| 参数 | ||
| ::::::::: | ||
|
|
||
| - **fn** - 类似empty/ones/zeros等任意函数 |
There was a problem hiding this comment.
先说是什么函数，再举例。比如：paddle公开的可创建Tensor的API。例如：paddle.empty、paddle.ones、paddle.zeros等paddle API
这里的API应该是可跳转的链接
There was a problem hiding this comment.
修改完成，查找学习了rst文件插入外部链接的办法
|
|
||
| - **fn** - 类似empty/ones/zeros等任意函数 | ||
| - **dist_attr** (paddle.distributed.DistAttr) - 描述 Tensor 在 ProcessMesh 上的分布或切片方式。 | ||
| - ***args** - fn函数可能存在的参数 |
There was a problem hiding this comment.
“可能存在”有点奇怪，直接说fn函数的输入参数是不是就行，而且和下面的参数介绍要不要区分一下，fn函数的输入参数（Tuple形式），下面是Dict形式
…dd_dtensor_from_fn_cn_doc resolve issues raised by code review
|
|
||
| .. py:class:: paddle.distributed.dtensor_from_fn(fn, dist_attr, *args, **kwargs) | ||
|
|
||
| 通过一个paddle API(一般是Tensor创建类的API)结合分布式属性dist_attr创建一个带有分布式属性的Tensor。 |
There was a problem hiding this comment.
中英文间需要保留空格，保证写作风格统一，也检查下其余的地方有没有类似的问题
Suggested change
| 通过一个paddle API(一般是Tensor创建类的API)结合分布式属性dist_attr创建一个带有分布式属性的Tensor。 | |
| 通过一个 paddle API（一般是 Tensor 创建类的 API）结合分布式属性 dist_attr 创建一个带有分布式属性的 Tensor。 |
| @@ -0,0 +1,30 @@ | |||
| .. _cn_api_distributed_dtensor_from_fn: | |||
There was a problem hiding this comment.
该 api_label 和路径对齐
Suggested change
| .. _cn_api_distributed_dtensor_from_fn: | |
| .. _cn_api_paddle_distributed_dtensor_from_fn: |
Comment on lines
13
to
16
| - **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 |
There was a problem hiding this comment.
既然是中文文档，引用的相关 API 文档也请用中文的，即
Suggested change
| - **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 | |
| - **fn** - paddle 公开的可创建 Tensor 的 API。例如： :ref:`cn_api_paddle_empty` 、 :ref:`cn_api_paddle_ones` 、:ref:`cn_api_paddle_zeros` 等 paddle API。 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add dtensor from fn cn doc
PADDLEPADDLE_PR=56565