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.

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

[cherry-pick2.4]docs fix #5401

Merged
merged 8 commits into from
Nov 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs/api/paddle/CUDAPlace_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ CUDAPlace
参数
::::::::::::

- **id** (int,可选) - GPU 的设备 ID。如果为 ``None``,则默认会使用 id 为 0 的设备。默认值为 ``None``
- **id** (int) - GPU 的设备 ID。

代码示例
::::::::::::
Expand Down
9 changes: 6 additions & 3 deletions docs/api/paddle/dist_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ x (4-D Tensor): 8 x 1 x 6 x 1

y (4-D Tensor): 1 x 7 x 1 x 5


(2) 确定输出 `z` 每一维度的大小:从两个输入的维度中选取最大值。

z (4-D Tensor): 8 x 7 x 6 x 5
Expand Down Expand Up @@ -49,9 +50,11 @@ z (4-D Tensor): 8 x 7 x 6 x 5
参数
::::::::::::

- **x** (Tensor): 1-D 到 6-D Tensor,数据类型为 float32 或 float64。
- **y** (Tensor): 1-D 到 6-D Tensor,数据类型为 float32 或 float64。
- **p** (float,optional):用于设置需要计算的范数,数据类型为 float32 或 float64。默认值为 2。
- **x** (Tensor) - 1-D 到 6-D Tensor,数据类型为 float32 或 float64。
- **y** (Tensor) - 1-D 到 6-D Tensor,数据类型为 float32 或 float64。
- **p** (float,可选) - 用于设置需要计算的范数,数据类型为 float32 或 float64。默认值为 2。



返回
::::::::::::
Expand Down
8 changes: 4 additions & 4 deletions docs/api/paddle/matmul_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ matmul

参数
:::::::::
- **x** (Tensor)输入变量,类型为 Tensor,数据类型为 float32, float64。
- **y** (Tensor)输入变量,类型为 Tensor,数据类型为 float32, float64。
- **transpose_x** (bool,可选)相乘前是否转置 x,默认值为 False。
- **transpose_y** (bool,可选)相乘前是否转置 y,默认值为 False。
- **x** (Tensor) - 输入变量,类型为 Tensor,数据类型为 float32, float64。
- **y** (Tensor) - 输入变量,类型为 Tensor,数据类型为 float32, float64。
- **transpose_x** (bool,可选) - 相乘前是否转置 x,默认值为 False。
- **transpose_y** (bool,可选) - 相乘前是否转置 y,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
6 changes: 4 additions & 2 deletions docs/api/paddle/meshgrid_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@ meshgrid



对每个张量做扩充操作。输入是张量或者包含张量的列表,包含 k 个一维张量,输出 k 个 k 维张量
对每个 Tensor 做扩充操作。输入是 Tensor 或者包含 Tensor 的列表,包含 k 个一维 Tensor,输出 k 个 k 维 Tensor

参数
::::::::::::

- \* **args** (Tensor|Tensor 数组)- 输入变量为 k 个一维张量,形状分别为(N1,), (N2,), ..., (Nk, )。支持数据类型为 float32float64int32int64。
- \* **args** (Tensor|Tensor 数组)- 输入变量为 k 个一维 Tensor,形状分别为(N1,), (N2,), ..., (Nk, )。支持数据类型为 float32float64int32int64。
- ** **kargs** (可选)- 目前只接受 name 参数(str),具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。



返回
::::::::::::

Expand Down
8 changes: 6 additions & 2 deletions docs/api/paddle/nonzero_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,17 @@ nonzero
参数
:::::::::

- **x** (Tensor)– 输入张量。
- **as_tuple** (bool, optinal) - 返回格式。是否以 ``1-D Tensor`` 构成的元组格式返回。
- **x** (Tensor)– 输入的 Tensor。
- **as_tuple** (bool,可选) - 返回格式。是否以 ``1-D Tensor`` 构成的元组格式返回。



返回
:::::::::
- **Tensor or tuple(1-D Tensor)**,数据类型为 **INT64** 。



代码示例
:::::::::

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/put_along_axis_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ put_along_axis
返回
:::::::::

- **out** (Tensor) - 输出 Tensor,indeces 矩阵选定的下标会被插入 value,与 ``arr`` 数据类型相同。
输出 Tensor,indeces 矩阵选定的下标会被插入 value,与 ``arr`` 数据类型相同。

代码示例
:::::::::
Expand Down
4 changes: 3 additions & 1 deletion docs/api/paddle/roll_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ roll

- **x** (Tensor)– 输入的 Tensor。
- **shifts** (int|list|tuple) - 滚动位移。如果 ``shifts`` 是一个元组或者列表,则 ``axis`` 必须是相同大小的元组或者列表,输入张量将依次沿着每个维度滚动相应的数值。
- **axis** (int|list|tuple, optinal) – 滚动轴。默认值为 None。
- **axis** (int|list|tuple,可选) – 滚动轴。默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。



返回
:::::::::

Expand Down
9 changes: 4 additions & 5 deletions docs/api/paddle/static/ipu_shard_guard_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@ ipu_shard_guard
对模型进行切分。用于指定 Op 在哪个 ipu 上进行计算以及模型被切分之后的计算顺序。

.. note::

仅支持当 enable_manual_shard=True,index 设置才有效。请参阅 :ref:`cn_api_fluid_IpuStrategy` 。
仅支持当 enable_pipelining=True,stage 设置才有效。请参阅 :ref:`cn_api_fluid_IpuStrategy` 。
仅支持当 enable_manual_shard=True,才能将 index 设置为非-1 的值。请参阅 :ref:`cn_api_fluid_IpuStrategy` 。
仅支持当 enable_pipelining=True,才能将 stage 设置为非-1 的值。请参阅 :ref:`cn_api_fluid_IpuStrategy` 。
一个 index 支持对应 None stage 或一个 stage,一个 stage 仅支持对应一个新的 index 或者一个重复的 index。

参数
:::::::::
- **index** (int,可选) - 指定 Op 在哪个 ipu 上计算,(如‘0, 1, 2, 3’),默认值-1,表示 Op 没有指定 ipu。
- **stage** (int,可选) 指定被切分的模型的计算顺序,(如‘0, 1, 2, 3’),按照数值大小顺序对被切分的模型进行计算,默认值-1,表示没有数据流水计算顺序并按照计算图顺序计算 Op。
- **index** (int,可选) - 指定 Op 在哪个 ipu 上计算,(如‘0, 1, 2, 3’),默认值-1,表示 Op 仅在 ipu 0 上运行
- **stage** (int,可选) - 指定被切分的模型的计算顺序,(如‘0, 1, 2, 3’),按照数值大小顺序对被切分的模型进行计算,默认值-1,表示没有数据流水计算顺序并按照计算图顺序计算 Op。

返回
:::::::::
Expand Down
12 changes: 6 additions & 6 deletions docs/api/paddle/static/mlu_places_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ mlu_places

.. py:function:: paddle.static.mlu_places(device_ids=None)


.. note::
多卡任务请先使用 FLAGS_selected_mlus 环境变量设置可见的 MLU 设备。

该接口根据 ``device_ids`` 创建一个或多个 ``paddle.device.MLUPlace`` 对象,并返回所创建的对象列表。

如果 ``device_ids`` 为 ``None``,则首先检查 ``FLAGS_selected_mlus`` 标志
如果 ``device_ids`` 为 ``None``,则首先检查 ``FLAGS_selected_mlus`` 环境变量
例如:``FLAGS_selected_mlus=0,1,2``,则返回的列表将为 ``[paddle.device.MLUPlace(0), paddle.device.MLUPlace(1), paddle.device.MLUPlace(2)]``。
如果未设置标志 ``FLAGS_selected_mlus``,则返回所有可见的 MLU places。

如果未设置环境变量 ``FLAGS_selected_mlus``,则返回所有可见的 MLU 位置。

如果 ``device_ids`` 不是 ``None``,它应该是使用的 MLU 设备 ID 的列表或元组。
例如:``device_id=[0,1,2]``,返回的列表将是 ``[paddle.device.MLUPlace(0), paddle.device.MLUPlace(1), paddle.device.MLUPlace(2)]``。

.. note::
多卡任务请先使用 FLAGS_selected_mlus 环境变量设置可见的 MLU 设备。

参数
:::::::::
- **device_ids** (list(int)|tuple(int),可选) - MLU 的设备 ID 列表或元组。默认值为 ``None``。
Expand Down
11 changes: 5 additions & 6 deletions docs/api/paddle/static/set_ipu_shard_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,19 @@ set_ipu_shard
通过设置输入的函数或计算层内每个算子的流水线属性实现对模型的切分。

.. note::

仅支持当 enable_manual_shard=True,index 设置才有效。请参阅 :ref:`cn_api_fluid_IpuStrategy` 。
仅支持当 enable_pipelining=True,stage 设置才有效。请参阅 :ref:`cn_api_fluid_IpuStrategy` 。
仅支持当 enable_manual_shard=True,才能将 index 设置为非-1 的值。请参阅 :ref:`cn_api_fluid_IpuStrategy` 。
仅支持当 enable_pipelining=True,才能将 stage 设置为非-1 的值。请参阅 :ref:`cn_api_fluid_IpuStrategy` 。
一个 index 支持对应 None stage 或一个 stage,一个 stage 仅支持对应一个新的 index 或者一个重复的 index。

参数
:::::::::
- **call_func** (Layer|function) - 静态图下的函数或者计算层。
- **index** (int,可选) - 指定 Op 在哪个 ipu 上计算,(如‘0, 1, 2, 3’),默认值-1,表示不指定 ipu。
- **stage** (int,可选) 指定被切分的模型的计算顺序,(如‘0, 1, 2, 3’),按照数值大小顺序对被切分的模型进行计算,默认值-1,表示没有数据流水计算顺序并按照计算图顺序计算 Op。
- **index** (int,可选) - 指定 Op 在哪个 ipu 上计算,(如‘0, 1, 2, 3’),默认值-1,表示 Op 仅在 ipu 0 上运行
- **stage** (int,可选) - 指定被切分的模型的计算顺序,(如‘0, 1, 2, 3’),按照数值大小顺序对被切分的模型进行计算,默认值-1,表示没有数据流水计算顺序并按照计算图顺序计算 Op。

返回
:::::::::
包装后的调用函数

代码示例
::::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/take_along_axis_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ take_along_axis
返回
:::::::::

- **out** (Tensor) - 输出 Tensor,包含 indeces 矩阵选定的元素,与 ``arr`` 数据类型相同。
输出 Tensor,包含 indeces 矩阵选定的元素,与 ``arr`` 数据类型相同。

代码示例
:::::::::
Expand Down
4 changes: 2 additions & 2 deletions docs/design/phi/design_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ Tensor scale(const Tensor& x,

C++ API 的自动生成是通过解析 YAML 配置文件来进行生成的,YAML 配置文件分为:

- 前向 API 配置文件(`paddle/phi/api/yaml/api.yaml`,解析后生成代码文件为`paddle/phi/api/include/api.h`和`paddle/phi/api/lib/api.cc`)
- 前向 API 配置文件(`paddle/phi/api/yaml/ops.yaml`,解析后生成代码文件为`paddle/phi/api/include/api.h`和`paddle/phi/api/lib/api.cc`)
- 反向 API 配置文件(`paddle/phi/api/yaml/backward.yaml`,解析后生成的代码文件为`paddle/phi/api/backward/backward_api.h`和`paddle/phi/api/lib/backward_api.cc`)。

C++ API 生成的关键在于 YAML 文件的配置,以 matmul 为例,其前向和反向的配置文件如下:
Expand Down Expand Up @@ -1642,7 +1642,7 @@ PHI 期望的 Op 开发方式:**“完形填空”式算子描述实现 + “
需要写的内容如下:

```
## 配置文件 api.yaml
## 配置文件 ops.yaml
- api : add
args : (const Tensor& x, const Tensor& y)
output : Tensor
Expand Down
2 changes: 1 addition & 1 deletion docs/design/phi/design_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ Described as follows:

The automatic generation of the C++ API is generated by parsing the YAML configuration file. The YAML configuration file is divided into:

- Forward API configuration file(`paddle/phi/api/yaml/api.yaml`. After parsing, the generated code file is `paddle/phi/api/include/api.h` and `paddle/phi/api/lib/api.cc`)
- Forward API configuration file(`paddle/phi/api/yaml/ops.yaml`. After parsing, the generated code file is `paddle/phi/api/include/api.h` and `paddle/phi/api/lib/api.cc`)
- Backward API configuration file(`paddle/phi/api/yaml/backward.yaml`. After parsing, the generated code file is `paddle/phi/api/backward/backward_api.h` and `paddle/phi/api/lib/backward_api.cc`)

The key to C++ API generation lies in the configuration of the YAML file. Taking `matmul` as an example, the forward and backward configuration are as follows:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,7 @@ API 的属性用来描述 API 所包含的属性。如果 API 有属性,每个
程序中随机运算符的默认随机种子。0 意味着随机生成随机种子。

**返回**

int64,返回该 Program 中当前正在使用的 random seed。

**代码示例**
Expand All @@ -335,12 +336,15 @@ API 的方法用来描述 API 所包含的方法,一些类的 API 会有这个
''''''''''''

.. py:function:: paddle.Program.parse_from_string(binary_str_type)

通过对 protobuf 的反序列化,转换成 ``Program``

**参数**
binary_str_type (**str**) – protobuf 二进制字符串

- **binary_str_type** (str) – protobuf 二进制字符串

**返回**

``Program``,反序列化后的 ``Program``

**代码示例**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ def trace(x, offset=0, axis1=0, axis2=1, name=None):

- `_C_ops` 是 [python/paddle/_C_ops.py](https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/_C_ops.py),其实现了从 Paddle 编译得到的二进制文件中 import C++ 算子对应的 Python C 函数。
- `trace` 是算子的 Python C 函数名。Python C 函数的命名直接采用算子名。
- 参数 `( x, offset, axis1, axis2 )`需按照 [YAML 配置文件](https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/phi/api/yaml/api.yaml#L185) 中定义的输入参数顺序传入,C++ 算子的输入、输出和属性等描述是通过 YAML 配置文件定义的,具体可参见 [开发 C++ 算子](new_cpp_op_cn.html) 章节介绍。
- 参数 `( x, offset, axis1, axis2 )`需按照 [YAML 配置文件](https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/phi/api/yaml/ops.yaml#L185) 中定义的输入参数顺序传入,C++ 算子的输入、输出和属性等描述是通过 YAML 配置文件定义的,具体可参见 [开发 C++ 算子](new_cpp_op_cn.html) 章节介绍。

> 注意:由于目前飞桨动态图正处在重构升级阶段,所以现有算子的代码会分别有新旧动态图两个代码分支,其中 `in_dygraph_mode()` 表示新动态图分支(默认),`_in_legacy_dygraph()`为旧动态图分支,**在新增算子时无需添加旧动态图分支代码**。

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/advanced/autograd_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PaddlePaddle 的神经网络核心是自动微分,本篇文章主要为你介
2.2.0


本案例首先定义网络。因为本示例着重展示如何使用飞桨进行自动微分,故组网部分不过多展开,直接使用高层 API 中封装好的模型\ ``vgg11``\
本案例首先定义网络。因为本示例着重展示如何使用飞桨进行自动微分,故组网部分不过多展开,直接使用高层 API 中封装好的模型 :ref:`paddle.vision.models <vgg11>`

然后随机初始化一个输入\ ``x``\ ,和对应标签\ ``label``\ 。

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/beginner/tensor_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ Tensor flattened to Vector: [1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 1
> * [paddle.squeeze](../../../api/paddle/squeeze_cn.html),可实现 Tensor 的降维操作,即把 Tensor 中尺寸为 1 的维度删除。
> * [paddle.unsqueeze](../../../api/paddle/unsqueeze_cn.html),可实现 Tensor 的升维操作,即向 Tensor 中某个位置插入尺寸为 1 的维度。
> * [paddle.flatten](../../../api/paddle/flatten_cn.html),将 Tensor 的数据在指定的连续维度上展平。
> * [transpose](../../../api/paddle/transpose_cn.html),对 Tensor 的数据进行重排。
> * [paddle.transpose](../../../api/paddle/transpose_cn.html),对 Tensor 的数据进行重排。
**(3)原位(Inplace)操作和非原位操作的区别**

Expand Down Expand Up @@ -545,7 +545,7 @@ Tensor(shape=[4], dtype=int64, place=Place(gpu:0), stop_gradient=True,

#### 4.1.2 修改 Tensor

与访问 Tensor 类似,修改 Tensor 可以在单个或多个维度上通过索引或切片操作。同时,支持将多种类型的数据赋值给该 Tensor,当前支持的数据类型有:`int``float``numpy.ndarray``omplex``Tensor`
与访问 Tensor 类似,修改 Tensor 可以在单个或多个维度上通过索引或切片操作。同时,支持将多种类型的数据赋值给该 Tensor,当前支持的数据类型有:`int``float``numpy.ndarray``complex``Tensor`
> **注意:**
>
> 请慎重通过索引或切片修改 Tensor,该操作会**原地**修改该 Tensor 的数值,且原值不会被保存。如果被修改的 Tensor 参与梯度计算,仅会使用修改后的数值,这可能会给梯度计算引入风险。飞桨框架会自动检测不当的原位(inplace)使用并报错。
Expand Down Expand Up @@ -673,7 +673,7 @@ x.matmul(y) #矩阵乘法
飞桨框架提供的一些 API 支持广播(broadcasting)机制,允许在一些运算时使用不同形状的 Tensor。
飞桨 Tensor 的广播机制主要遵循如下规则(参考 [Numpy 广播机制](https://numpy.org/doc/stable/user/basics.broadcasting.html#module-numpy.doc.broadcasting)):

* 每个 Tensor 至少为一维 Tensor
* 每个 Tensor 至少为一维 Tensor
* 从最后一个维度向前开始比较两个 Tensor 的形状,需要满足如下条件才能进行广播:两个 Tensor 的维度大小相等;或者其中一个 Tensor 的维度等于 1;或者其中一个 Tensor 的维度不存在。

举例如下:
Expand Down
Loading