Skip to content

Commit

Permalink
Support tuple (PaddlePaddle#6200)
Browse files Browse the repository at this point in the history
* update_windows_compile_docs

* support_tuple
  • Loading branch information
xuxinyi389 authored Sep 21, 2023
1 parent 7b550b2 commit 0786cae
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/api/paddle/distributed/fleet/UtilBase_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ all_reduce(input, mode="sum", comm_world="worker")

**参数**

- **input** (list|numpy.array) – 归约操作的输入。
- **input** (list|tuple|numpy.array) – 归约操作的输入。
- **mode** (str) - 归约操作的模式,包含求和,取最大值和取最小值,默认为求和归约。
- **comm_world** (str) - 归约操作的通信集合,包含:server 集合(``server``),worker 集合(``worker``)及所有节点集合(``all``),默认为 worker 集合。

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/distribution/Categorical_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Categorical
参数
::::::::::::

- **logits** (list|numpy.ndarray|Tensor) - 类别分布对应的 logits。数据类型为 float32 或 float64。
- **logits** (list|tuple|numpy.ndarray|Tensor) - 类别分布对应的 logits。数据类型为 float32 或 float64。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

代码示例
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/min_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ min
参数
:::::::::
- **x** (Tensor)- Tensor,支持数据类型为 float32、float64、int32、int64。
- **axis** (list|int,可选)- 求最小值运算的维度。如果为 None,则计算所有元素的最小值并返回包含单个元素的 Tensor 变量,否则必须在 :math:`[−x.ndim, x.ndim]` 范围内。如果 :math:`axis[i] < 0`,则维度将变为 :math:`x.ndim+axis[i]`,默认值为 None。
- **axis** (list|tuple|int,可选)- 求最小值运算的维度。如果为 None,则计算所有元素的最小值并返回包含单个元素的 Tensor 变量,否则必须在 :math:`[−x.ndim, x.ndim]` 范围内。如果 :math:`axis[i] < 0`,则维度将变为 :math:`x.ndim+axis[i]`,默认值为 None。
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留输入的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

Expand Down
6 changes: 3 additions & 3 deletions docs/api/paddle/nn/Layer_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ float(excluded_layers=None)

**参数**

- **excluded_layers** (list|nn.Layer|None,可选) - 不需要转换数据类型的层。如果 ``excluded_layers`` 为 None,则转换所有浮点参数和缓冲区,默认值:None。
- **excluded_layers** (list|tuple|nn.Layer|None,可选) - 不需要转换数据类型的层。如果 ``excluded_layers`` 为 None,则转换所有浮点参数和缓冲区,默认值:None。

**代码示例**

Expand All @@ -430,7 +430,7 @@ float16(excluded_layers=None)

**参数**

- **excluded_layers** (list|nn.Layer|None,可选) - 不需要转换数据类型的层。如果 ``excluded_layers`` 为 None,则转换除 ``nn.BatchNorm`` 之外的所有浮点参数和缓冲区,默认值:None。
- **excluded_layers** (list|tuple|nn.Layer|None,可选) - 不需要转换数据类型的层。如果 ``excluded_layers`` 为 None,则转换除 ``nn.BatchNorm`` 之外的所有浮点参数和缓冲区,默认值:None。

**代码示例**

Expand All @@ -446,7 +446,7 @@ bfloat16(excluded_layers=None)

**参数**

- **excluded_layers** (list|nn.Layer|None,可选) - 不需要转换数据类型的层。如果 ``excluded_layers`` 为 None,则转换除 ``nn.BatchNorm`` 之外的所有浮点参数和缓冲区,默认值:None。
- **excluded_layers** (list|tuple|nn.Layer|None,可选) - 不需要转换数据类型的层。如果 ``excluded_layers`` 为 None,则转换除 ``nn.BatchNorm`` 之外的所有浮点参数和缓冲区,默认值:None。

**代码示例**

Expand Down
8 changes: 4 additions & 4 deletions docs/api/paddle/nn/Unfold_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Unfold
参数
::::::::::::

- **kernel_sizes** (int|list of int) – 卷积核的尺寸,整数或者整型列表。如果为整型列表,应包含两个元素 ``[k_h, k_w]``,卷积核大小为 ``k_h * k_w``;如果为整数 k,会被当作整型列表 ``[k, k]`` 处理
- **dilations** (int|list of int,可选) – 卷积膨胀,整型列表或者整数。如果为整型列表,应该包含两个元素[dilation_h, dilation_w]。如果是整数 dilation,会被当作整型列表[dilation, dilation]处理。默认值为 1
- **paddings** (int|list of int,可选) – 每个维度的扩展,整数或者整型列表。如果为整型列表,长度应该为 4 或者 2;长度为 4 对应的 padding 参数是:[padding_top, padding_left,padding_bottom, padding_right],长度为 2 对应的 padding 参数是[padding_h, padding_w],会被当作[padding_h, padding_w, padding_h, padding_w]处理。如果为整数 padding,则会被当作[padding, padding, padding, padding]处理。默认值为 0
- **strides** (int|list of int,可选) – 卷积步长,整数或者整型列表。如果为整型列表,应该包含两个元素 ``[stride_h, stride_w]``。如果为整数,则 ``stride_h = stride_w = strides``。默认值为 1
- **kernel_sizes** (int|list(tuple) of int) – 卷积核的尺寸,整数或者整型列表。如果为整型列表,应包含两个元素 ``[k_h, k_w]``,卷积核大小为 ``k_h * k_w``;如果为整数 k,会被当作整型列表 ``[k, k]`` 处理
- **dilations** (int|list(tuple) of int,可选) – 卷积膨胀,整型列表或者整数。如果为整型列表,应该包含两个元素[dilation_h, dilation_w]。如果是整数 dilation,会被当作整型列表[dilation, dilation]处理。默认值为 1
- **paddings** (int|list(tuple) of int,可选) – 每个维度的扩展,整数或者整型列表。如果为整型列表,长度应该为 4 或者 2;长度为 4 对应的 padding 参数是:[padding_top, padding_left,padding_bottom, padding_right],长度为 2 对应的 padding 参数是[padding_h, padding_w],会被当作[padding_h, padding_w, padding_h, padding_w]处理。如果为整数 padding,则会被当作[padding, padding, padding, padding]处理。默认值为 0
- **strides** (int|list(tuple) of int,可选) – 卷积步长,整数或者整型列表。如果为整型列表,应该包含两个元素 ``[stride_h, stride_w]``。如果为整数,则 ``stride_h = stride_w = strides``。默认值为 1
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

形状
Expand Down
8 changes: 4 additions & 4 deletions docs/api/paddle/nn/functional/unfold_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ unfold
::::::::::::

- **x** (Tensor) – 输入 4-D Tensor,形状为[N, C, H, W],数据类型为 float32 或者 float64
- **kernel_sizes** (int|list of int) – 卷积核的尺寸,整数或者整型列表。如果为整型列表,应包含两个元素 ``[k_h, k_w]``,卷积核大小为 ``k_h * k_w``;如果为整数 k,会被当作整型列表 ``[k, k]`` 处理
- **strides** (int|list of int,可选) – 卷积步长,整数或者整型列表。如果为整型列表,应该包含两个元素 ``[stride_h, stride_w]``。如果为整数,则 ``stride_h = stride_w = strides``。默认值为 1
- **paddings** (int|list of int,可选) – 每个维度的扩展,整数或者整型列表。如果为整型列表,长度应该为 4 或者 2;长度为 4 对应的 padding 参数是:[padding_top, padding_left,padding_bottom, padding_right],长度为 2 对应的 padding 参数是[padding_h, padding_w],会被当作[padding_h, padding_w, padding_h, padding_w]处理。如果为整数 padding,则会被当作[padding, padding, padding, padding]处理。默认值为 0
- **dilations** (int|list of int,可选) – 卷积膨胀,整型列表或者整数。如果为整型列表,应该包含两个元素[dilation_h, dilation_w]。如果是整数 dilation,会被当作整型列表[dilation, dilation]处理。默认值为 1
- **kernel_sizes** (int|list(tuple) of int) – 卷积核的尺寸,整数或者整型列表。如果为整型列表,应包含两个元素 ``[k_h, k_w]``,卷积核大小为 ``k_h * k_w``;如果为整数 k,会被当作整型列表 ``[k, k]`` 处理
- **strides** (int|list(tuple) of int,可选) – 卷积步长,整数或者整型列表。如果为整型列表,应该包含两个元素 ``[stride_h, stride_w]``。如果为整数,则 ``stride_h = stride_w = strides``。默认值为 1
- **paddings** (int|list(tuple) of int,可选) – 每个维度的扩展,整数或者整型列表。如果为整型列表,长度应该为 4 或者 2;长度为 4 对应的 padding 参数是:[padding_top, padding_left,padding_bottom, padding_right],长度为 2 对应的 padding 参数是[padding_h, padding_w],会被当作[padding_h, padding_w, padding_h, padding_w]处理。如果为整数 padding,则会被当作[padding, padding, padding, padding]处理。默认值为 0
- **dilations** (int|list(tuple) of int,可选) – 卷积膨胀,整型列表或者整数。如果为整型列表,应该包含两个元素[dilation_h, dilation_w]。如果是整数 dilation,会被当作整型列表[dilation, dilation]处理。默认值为 1
- **name** (str,可选) – 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。


Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/vision/ops/box_coder_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ box_coder
参数
::::::::::::
- **prior_box** (Tensor) - 维度为 [M, 4] 的 2-D Tensor , M 表示存储 M 个框,数据类型为 float32 或 float64 。先验框,每个框代表 [xmin, ymin, xmax, ymax] , [xmin, ymin] 是先验框的左顶点坐标,如果输入数图像特征图,则接近坐标原点。 [xmax,ymax] 是先验框的右底点坐标。
- **prior_box_var** (List|Tensor|None) - 支持三种输入类型,一是维度为 [M, 4] 的 2-D Tensor ,存储 M 个先验框的 variance ,数据类型为 float32 或 float64 。另一种是一个长度为 4 的列表,所有先验框共用这个列表中的 variance ,数据类型为 float32 或 float64 。为 None 时不参与计算。
- **prior_box_var** (List|tuple|Tensor|None) - 支持三种输入类型,一是维度为 [M, 4] 的 2-D Tensor ,存储 M 个先验框的 variance ,数据类型为 float32 或 float64 。另一种是一个长度为 4 的列表,所有先验框共用这个列表中的 variance ,数据类型为 float32 或 float64 。为 None 时不参与计算。
- **target_box** (Tensor) - 数据类型为 float32 或 float64 的 Tensor ,当 code_type 为 `encode_center_size` ,输入是 2-D Tensor ,维度为 [N, 4] , N 为目标框的个数,目标框的格式与先验框相同。当 code_type 为 `decode_center_size` ,输入为 3-D Tensor ,维度为 [N, M, 4]。通常 N 表示产生检测框的个数, M 表示类别数。此时目标框为偏移量。
- **code_type** (str,可选) - 编码类型用目标框,可以是 `encode_center_size` 或 `decode_center_size` ,默认值为 `encode_center_size` 。
- **box_normalized** (bool,可选) - 先验框坐标是否正则化,即是否在 [0, 1] 区间内。默认值为 True 。
Expand Down

0 comments on commit 0786cae

Please sign in to comment.