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

修复 paddle\add 等 API 的文档 #6197

Merged
merged 3 commits into from
Sep 25, 2023
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
7 changes: 1 addition & 6 deletions docs/api/paddle/add_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,9 @@ add
- :math:`X`:多维 Tensor。
- :math:`Y`:多维 Tensor。

如下两种情况使用该算子:
第一种情况:
以下情况使用该算子,该情况为:
1. ``X`` 与 ``Y`` 的形状一样。
2. ``Y`` 的形状是 ``X`` 的一部分连续的形状。
第二种情况:
1. 广播 ``Y`` 使其形状与 ``X`` 相同,其中 ``axis`` 是把 ``Y`` 广播到 ``X`` 的索引起始数。
2. 如果 ``axis`` 是默认值-1,则 :math:`axis=rank(X)−rank(Y)`。
3. ``Y`` 的最后一维形状为 1 时,该维度将会被忽略,比如 shape(Y) = (2, 1) => (2)。


参数
Expand Down
6 changes: 3 additions & 3 deletions docs/api/paddle/full_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ full
参数
::::::::::::

- **shape** (list|tuple|Tensor) – 指定创建 Tensor 的形状(shape),数据类型为 int32 或者 int64。
- **fill_value** (bool|float|int|Tensor) - 用于初始化输出 Tensor 的常量数据的值。注意:该参数不可超过输出变量数据类型的表示范围。
- **dtype** (np.dtype|str,可选)- 输出变量的数据类型。若为 None,则输出变量的数据类型和输入变量相同,默认值为 None。
- **shape** (list|tuple|Tensor) – 指定创建 Tensor 的形状(shape),数据类型为 int32 或者 int64。如果 ``shape`` 是一个 list 或 tuple ,它的每个元素应该是整数或者是形状为[]的 0-D Tensor 。如果 ``shape`` 是一个 Tensor ,它应该是一个表示 list 的 1-D 张量。
- **fill_value** (bool|float|int|Tensor) - 用于初始化输出 Tensor 的常量数据的值。如果 fill_value 是一个 Tensor ,它应该是一个表示标量的 0-D Tensor。注意:该参数不可超过输出变量数据类型的表示范围。
- **dtype** (np.dtype|str,可选)- 输出变量的数据类型,可以是 float16、float32、float64、int32、int64。如果 dytpe 为 None,则创建的 Tensor 的数据类型为 float32。默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
8 changes: 4 additions & 4 deletions docs/api/paddle/nn/Conv2DTranspose_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Conv2DTranspose

二维转置卷积层(Convlution2d transpose layer)

该层根据输入(input)、卷积核(kernel)和空洞大小(dilations)、步长(stride)、填充(padding)来计算输出特征层大小或者通过 output_size 指定输出特征层大小。输入(Input)和输出(Output)为 NCHW 或 NHWC 格式,其中 N 为批尺寸,C 为通道数(channel),H 为特征层高度,W 为特征层宽度。卷积核是 MCHW 格式,M 是输出图像通道数,C 是输入图像通道数,H 是卷积核高度,W 是卷积核宽度。如果组数大于 1,C 等于输入图像通道数除以组数的结果。转置卷积的计算过程相当于卷积的反向计算。转置卷积又被称为反卷积(但其实并不是真正的反卷积)。欲了解转置卷积层细节,请参考下面的说明和 `参考文献 <https://arxiv.org/pdf/1603.07285.pdf/>`_。如果参数 bias_attr 不为 False,转置卷积计算会添加偏置项。
该层根据输入(input)、卷积核(kernel)和空洞大小(dilations)、步长(stride)、填充(padding)来计算输出特征层大小或者通过 output_size 指定输出特征层大小。输入(Input)和输出(Output)为 NCHW 或 NHWC 格式,其中 N 为批尺寸(batch size),C 为通道数(channel),H 为特征层高度,W 为特征层宽度。卷积核是 MCHW 格式,M 是输出图像通道数,C 是输入图像通道数,H 是卷积核高度,W 是卷积核宽度。如果组数大于 1,C 等于输入图像通道数除以组数的结果。转置卷积的计算过程相当于卷积的反向计算。转置卷积又被称为反卷积(但其实并不是真正的反卷积)。欲了解转置卷积层细节,请参考下面的说明和 `参考文献 <https://arxiv.org/pdf/1603.07285.pdf/>`_。如果参数 bias_attr 不为 False,转置卷积计算会添加偏置项。

输入 :math:`X` 和输出 :math:`Out` 函数关系如下:

Expand Down Expand Up @@ -39,11 +39,11 @@ Conv2DTranspose
- **in_channels** (int) - 输入图像的通道数。
- **out_channels** (int) - 卷积核的个数,和输出特征图通道数相同。
- **kernel_size** (int|list|tuple) - 卷积核大小。可以为单个整数或包含两个整数的元组或列表,分别表示卷积核的高和宽。如果为单个整数,表示卷积核的高和宽都等于该整数。
- **stride** (int|tuple,可选) - 步长大小。如果 ``stride`` 为元组或列表,则必须包含两个整型数,分别表示垂直和水平滑动步长。否则,表示垂直和水平滑动步长均为 ``stride``。默认值:1。
- **padding** (int|tuple,可选) - 填充大小。如果 ``padding`` 为元组或列表,则必须包含两个整型数,分别表示竖直和水平边界填充大小。否则,表示竖直和水平边界填充大小均为 ``padding``。如果它是一个字符串,可以是"VALID"或者"SAME",表示填充算法,计算细节可参考下方形状 ``padding`` = "SAME"或 ``padding`` = "VALID" 时的计算公式。默认值:0。
- **stride** (int|list|tuple,可选) - 步长大小。如果 ``stride`` 为元组或列表,则必须包含两个整型数,分别表示垂直和水平滑动步长。否则,表示垂直和水平滑动步长均为 ``stride``。默认值:1。
- **padding** (int|str|tuple|list,可选) - 填充大小。如果 ``padding`` 为元组或列表,则必须包含两个整型数,分别表示竖直和水平边界填充大小。否则,表示竖直和水平边界填充大小均为 ``padding``。如果它是一个字符串,可以是"VALID"或者"SAME",表示填充算法,计算细节可参考下方形状 ``padding`` = "SAME"或 ``padding`` = "VALID" 时的计算公式。默认值:0。
- **output_padding** (int|list|tuple,可选) - 输出形状上一侧额外添加的大小。默认值:0。
- **groups** (int,可选) - 二维卷积层的组数。根据 Alex Krizhevsky 的深度卷积神经网络(CNN)论文中的分组卷积:当 group=2,卷积核的前一半仅和输入特征图的前一半连接。卷积核的后一半仅和输入特征图的后一半连接。默认值:1。
- **dilation** (int|tuple,可选) - 空洞大小。可以为单个整数或包含两个整数的元组或列表,分别表示卷积核中的元素沿着高和宽的空洞。如果为单个整数,表示高和宽的空洞都等于该整数。默认值:1。
- **dilation** (int|list|tuple,可选) - 空洞大小。可以为单个整数或包含两个整数的元组或列表,分别表示卷积核中的元素沿着高和宽的空洞。如果为单个整数,表示高和宽的空洞都等于该整数。默认值:1。
- **weight_attr** (ParamAttr,可选) - 指定权重参数属性的对象。默认值为 None,表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
- **bias_attr** (ParamAttr|bool,可选) - 指定偏置参数属性的对象。默认值为 None,表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
- **data_format** (str,可选) - 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是"NCHW"和"NHWC"。N 是批尺寸,C 是通道数,H 是特征高度,W 是特征宽度。默认值:"NCHW"。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/initializer/Constant_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Constant
参数
::::::::::::

- **value** (float16|float32,可选) - 用于初始化输入变量的值,默认值为 0。
- **value** (float16|float32,可选) - 用于初始化输入变量的值,默认值为 0.0

返回
::::::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/rand_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ rand
参数
::::::::::
- **shape** (list|tuple|Tensor) - 生成的随机 Tensor 的形状。如果 ``shape`` 是 list、tuple,则其中的元素可以是 int,或者是形状为[]且数据类型为 int32、int64 的 0-D Tensor。如果 ``shape`` 是 Tensor,则是数据类型为 int32、int64 的 1-D Tensor。
- **dtype** (str|np.dtype,可选) - 输出 Tensor 的数据类型,支持 float32、float64。当该参数值为 None 时,输出 Tensor 的数据类型为 float32。默认值为 None。
- **dtype** (str|np.dtype,可选) - 输出 Tensor 的数据类型,支持 float32、float64。当该参数值为 None 时,输出 Tensor 的数据类型为 float32。使用全局默认 dtype(详细信息请见 :ref:`get_default_dtype` )。默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/shape_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ shape 层。
参数
::::::::::::

- **input** (Tensor)- 输入的多维 Tensor 或 SelectedRows,数据类型为 bfloat16,float16,float32,float64,int32,int64。如果输入是 SelectedRows 类型,则返回其内部持有 Tensor 的 shape。
- **input** (Variable)- 输入的多维 Tensor 或 SelectedRows,数据类型为 bool, bfloat16,float16,float32,float64,int32,int64。如果输入是 SelectedRows 类型,则返回其内部持有 Tensor 的 shape。


返回
Expand Down
7 changes: 4 additions & 3 deletions docs/api/paddle/static/InputSpec_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@ InputSpec
-------------------------------


.. py:class:: paddle.static.InputSpec(shape=None, dtype='float32', name=None)
.. py:class:: paddle.static.InputSpec(shape, dtype='float32', name=None, stop_gradient=False)
用于描述模型输入的签名信息,包括 shape、dtype 和 name。

此接口常用于指定高层 API 中模型的输入 Tensor 信息,或动态图转静态图时,指定被 ``paddle.jit.to_static`` 装饰的 forward 函数每个输入参数的 Tensor 信息。

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

- **shape** (list|tuple)- 声明维度信息的 list 或 tuple,默认值为 None。
- **shape** (tuple(integers)|list[integers])- 声明维度信息的 list 或 tuple,默认值为 None。设置为 ``None`` 或 ``-1`` 时表示维度可以是任意大小。例如,可以将可变的批尺寸(batch size)设置为 ``None`` 或 ``-1``
- **dtype** (np.dtype|str,可选)- 数据类型,支持 bool,float16,float32,float64,int8,int16,int32,int64,uint8。默认值为 float32。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
- **name** (str,可选) - 变量的名称,具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
- **stop_gradient** (bool,可选) - 提示是否应该停止计算梯度,默认值为 False,表示不停止计算梯度。

返回
::::::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/static/load_inference_model_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ load_inference_model
参数
::::::::::::

- **path_prefix** (str) – 模型的存储目录 + 模型名称(不包含后缀)。如果是 None,表示从内存加载模型。
- **path_prefix** (str|None) – 模型的存储目录 + 模型名称(不包含后缀)。如果是 None,表示从内存加载模型。
- **executor** (Executor) – 运行模型的 ``executor``,详见 :ref:`api_guide_executor` 。
- **kwargs** - 支持的 key 包括 'model_filename', 'params_filename'。(注意:kwargs 主要是用来做反向兼容的)。

Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/vision/transforms/Normalize__upper_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Normalize
参数
:::::::::

- **mean** (list|tuple,可选) - 用于每个通道归一化的均值。
- **std** (list|tuple,可选) - 用于每个通道归一化的标准差值。
- **mean** (int|float|list|tuple,可选) - 用于每个通道归一化的均值。
- **std** (int|float|list|tuple,可选) - 用于每个通道归一化的标准差值。
- **data_format** (str,可选) - 数据的格式,必须为 'HWC' 或 'CHW'。 默认值为 'CHW'。
- **to_rgb** (bool,可选) - 是否转换为 ``rgb`` 的格式。默认值为 False。
- **keys** (list[str]|tuple[str],可选) - 与 ``BaseTransform`` 定义一致。默认值为 None。
Expand Down