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

[fp16] Add fp16 support on some cn docs #5656

Merged
merged 15 commits into from
Feb 28, 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
2 changes: 1 addition & 1 deletion docs/api/paddle/broadcast_to_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ broadcast_to

参数
:::::::::
- **x** (Tensor) - 输入的 Tensor,数据类型为:bool、float32、float64、int32 或 int64。
- **x** (Tensor) - 输入的 Tensor,数据类型为:bool、float16、float32、float64、int32 或 int64。
- **shape** (tuple|list|Tensor) - 给定输入 ``x`` 扩展后的形状,若 ``shape`` 为 list 或者 tuple,则其中的元素值应该为整数或者 1-D Tensor,若 ``shape`` 类型为 Tensor,则其应该为 1-D Tensor。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

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

- **x** (Tensor) - 多维 Tensor,数据类型可以为 float32、float64、int8、int32 或 int64。
- **x** (Tensor) - 多维 Tensor,数据类型可以为 float16、float32、float64、int8、int32 或 int64。
- **start_axis** (int) - flatten 展开的起始维度。
- **stop_axis** (int) - flatten 展开的结束维度。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/gather_nd_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ gather_nd
参数
::::::::::::

- **x** (Tensor) - 输入 Tensor,数据类型可以是 int32、int64、float32、float64、bool。
- **x** (Tensor) - 输入 Tensor,数据类型可以是 int32、int64、float16、float32、float64、bool。
- **index** (Tensor) - 输入的索引 Tensor,其数据类型 int32 或者 int64。它的维度 :code:`index.rank` 必须大于 1,并且 :code:`index.shape[-1] <= x.rank` 。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

Expand Down
25 changes: 25 additions & 0 deletions docs/api/paddle/nansum_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.. _cn_api_tensor_math_nansum:

nansum
-------------------------------

.. py:function:: paddle.nansum(x, axis=None, dtype=None, keepdim=False, name=None)

计算给定轴上的元素之和,并将非数字元素(NaNs)视为 0。

参数
:::::::::
- **x** (Tensor) - 输入的 Tensor,数据类型为:float16、float32、float64、int32 或 int64。
- **axis** (int|list|tuple,可选) - 求和运算的维度。如果为 None,则计算所有元素的和并返回包含单个元素的 Tensor 变量,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`,则维度将变为 :math:`rank+axis[i]`,默认值为 None。
- **dtype** (str,可选) - 输出变量的数据类型。若参数为空,则输出变量的数据类型和输入变量相同,默认值为 None。
- **keepdim** (bool) - 是否在输出 Tensor 中保留减小的维度。如 keepdim 为 True,否则结果 Tensor 的维度将比输入 Tensor 小,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
:::::::::
``Tensor``,在指定维度上进行求和运算的 Tensor,数据类型和输入数据类型一致。

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

COPY-FROM: paddle.nansum
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/functional/alpha_dropout_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ alpha_dropout 是一种具有自归一化性质的 dropout。均值为 0,方

参数
:::::::::
- **x** (Tensor):输入的多维 `Tensor`,数据类型为:float32、float64。
- **x** (Tensor):输入的多维 `Tensor`,数据类型为:float16、float32 或 float64。
- **p** (float):将输入节点置 0 的概率,即丢弃概率。默认:0.5。
- **training** (bool):标记是否为训练阶段。默认:True。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/functional/avg_pool3d_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ avg_pool3d

参数
:::::::::
- **x** (Tensor):形状为 [N,C,D,H,W] 或 [N,D,H,W,C] 的 5-D Tensor,N 是批尺寸,C 是通道数,D 是特征深度,H 是特征高度,W 是特征宽度,数据类型为 float32 或 float64。
- **x** (Tensor):形状为 [N,C,D,H,W] 或 [N,D,H,W,C] 的 5-D Tensor,N 是批尺寸,C 是通道数,D 是特征深度,H 是特征高度,W 是特征宽度,数据类型为 float16、float32 或 float64。
- **kernel_size** (int|list|tuple):池化核大小。如果它是一个元组或列表,它必须包含三个整数值,(pool_size_Depth, pool_size_Height, pool_size_Width)。若为一个整数,则表示 D,H 和 W 维度上均为该值,比如若 pool_size=2,则池化核大小为[2,2,2]。
- **stride** (int|list|tuple):池化层的步长。如果它是一个元组或列表,它将包含两个整数,(pool_stride_Height, pool_stride_Width)。若为一个整数,则表示 H 和 W 维度上 stride 均为该值。默认值为 kernel_size。
- **padding** (string|int|list|tuple) 池化填充。如果它是一个元组或列表,它可以有 3 种格式:(1)包含 3 个整数值:[pad_depth, pad_height, pad_width];(2)包含 6 个整数值:[pad_depth_front, pad_depth_back, pad_height_top, pad_height_bottom, pad_width_left, pad_width_right];(3)包含 5 个二元组:当 data_format 为"NCDHW"时为[[0,0], [0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]],当 data_format 为"NDHWC"时为[[0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数,则表示 D、H 和 W 维度上均为该值。默认值:0。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/functional/dropout2d_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ dropout2d

参数
:::::::::
- **x** (Tensor) - 形状为 [N, C, H, W] 或 [N, H, W, C] 的 4D `Tensor`。数据类型为 float32 或 float64。
- **x** (Tensor) - 形状为 [N, C, H, W] 或 [N, H, W, C] 的 4D `Tensor`。数据类型为 float16、float32 或 float64。
- **p** (float,可选) - 将输入通道置 0 的概率,即丢弃概率。默认值为 0.5。
- **training** (bool,可选) - 标记是否为训练阶段。默认值为 True。
- **data_format** (str,可选) - 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是 `NCHW` 和 `NHWC`。其中 `N` 是批尺寸,`C` 是通道数,`H` 是特征高度,`W` 是特征宽度。默认值为 `NCHW` 。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/functional/dropout_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Dropout 是一种正则化手段,可根据给定的丢弃概率 `p`,在训

参数
:::::::::
- **x** (Tensor) - 输入的多维 `Tensor`,数据类型为:float32、float64。
- **x** (Tensor) - 输入的多维 `Tensor`,数据类型为:float16、float32、float64。
- **p** (float,可选) - 将输入节点置 0 的概率,即丢弃概率。默认值为 0.5。
- **axis** (int|list,可选) - 指定对输入 `Tensor` 进行 dropout 操作的轴。默认值为 None。
- **training** (bool,可选) - 标记是否为训练阶段。默认值为 True。
Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/nn/functional/local_response_norm_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ local_response_norm

参数
:::::::::
- **x** (Tensor)- 输入的3-D/4-D/5-D `Tensor`,数据类型为:float32。
- **x** (Tensor)- 输入的 3-D/4-D/5-D `Tensor`,数据类型为:float16 或 float32。
- **size** (int) - 累加的通道数。
- **alpha** (float,可选)- 缩放参数,正数。默认值为 1e-4。
- **beta** (float,可选)- 指数,正数。默认值为 0.75。
- **k** (float,可选)- 位移,正数。默认值为 1.0。
- **data_format** (str,可选) - 指定输入的数据格式,输出的数据格式将与输入保持一致。如果输入是3-D `Tensor`,该参数可以是"NCL"或"NLC",其中 N 是批尺寸,C 是通道数,L 是特征长度。如果输入是4-D `Tensor`,该参数可以是"NCHW"或"NHWC",其中 N 是批尺寸,C 是通道数,H 是特征高度,W 是特征宽度。如果输入是5-D `Tensor`,该参数可以是"NCDHW"或"NDHWC",其中 N 是批尺寸,C 是通道数,D 是特征深度,H 是特征高度,W 是特征宽度。默认值:"NCHW"。
- **data_format** (str,可选) - 指定输入的数据格式,输出的数据格式将与输入保持一致。如果输入是 3-D `Tensor`,该参数可以是"NCL"或"NLC",其中 N 是批尺寸,C 是通道数,L 是特征长度。如果输入是 4-D `Tensor`,该参数可以是"NCHW"或"NHWC",其中 N 是批尺寸,C 是通道数,H 是特征高度,W 是特征宽度。如果输入是 5-D `Tensor`,该参数可以是"NCDHW"或"NDHWC",其中 N 是批尺寸,C 是通道数,D 是特征深度,H 是特征高度,W 是特征宽度。默认值:"NCHW"。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/functional/temporal_shift_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ temporal_shift

参数
:::::::::
- **x** (Tensor) – 时移算符的输入 Tensor。维度为 :math:`[N*T,C,H,W]` 的 4-D Tensor。N 为批量大小,T 为时间段数,C 为信道数,H 为特征高度,W 为特征宽度,数据类型为 float32 或 float64。
- **x** (Tensor) – 时移算符的输入 Tensor。维度为 :math:`[N*T,C,H,W]` 的 4-D Tensor。N 为批量大小,T 为时间段数,C 为信道数,H 为特征高度,W 为特征宽度,数据类型为 float16、float32 或 float64。
- **seg_num** (int) – 时间段编号,这应该是一个正整数。
- **shift_ratio** (float,可选) – 通道的移位比、通道的第一个 ``shift_ratio`` 部分沿时间维度移动-1,通道的第二个 ``shift_ratio`` 部分沿时间维度移动 1,范围须在 [0, 0.5] 内。默认值 0.25
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/unbind_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ unbind

参数
:::::::::
- **input** (Tensor) - 输入变量,数据类型为 float32、float64、int32、int64 的多维 Tensor。
- **input** (Tensor) - 输入变量,数据类型为 float16、loat32、float64、int32、int64 的多维 Tensor。
- **axis** (int32|int64,可选) - 数据类型为 int32 或 int64,表示需要分割的维度。如果 axis < 0,则划分的维度为 rank(input) + axis。默认值为 0。

返回
Expand Down