add_dtensor_from_fn_cn_doc #6130
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,30 @@ | ||||||||||||
| .. _cn_api_distributed_dtensor_from_fn: | ||||||||||||
|
|
||||||||||||
| dtensor_from_fn | ||||||||||||
| ------------------------------- | ||||||||||||
|
|
||||||||||||
| .. 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
|
||||||||||||
|
|
||||||||||||
| 参数 | ||||||||||||
| ::::::::: | ||||||||||||
|
|
||||||||||||
| - **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
|
||||||||||||
| - **dist_attr** (paddle.distributed.DistAttr) - 描述 Tensor 在 ProcessMesh 上的分布或切片方式。 | ||||||||||||
| - ***args** - fn函数的输入参数(Tuple形式) | ||||||||||||
| - ****kwargs** - fn函数的输入参数(Dict形式) | ||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| 返回 | ||||||||||||
| ::::::::: | ||||||||||||
| 带有分布式信息的 Tensor | ||||||||||||
|
|
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| **代码示例** | ||||||||||||
|
|
||||||||||||
| COPY-FROM: paddle.distributed.dtensor_from_fn | ||||||||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
该 api_label 和路径对齐
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done