Merge branch 'develop' of https://github.com/PaddlePaddle/docs into fix-t6-t10

Author: Ricardo-shuo-liu

README.md

@@ -5,7 +5,7 @@ English | [简体中文](./README_cn.md) | [日本語](./README_ja.md)
 
 Source files for contents presented at [PaddlePaddle documentation](https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html).
 
-Note: English version API docs are generaly docstrings in [PaddlePaddle/Paddle](https://github.com/PaddlePaddle/Paddle), documents for [other PaddlePaddle projects](https://www.paddlepaddle.org.cn/overview) are being managed in their respective ways.
+Note: English version API docs are generally docstrings in [PaddlePaddle/Paddle](https://github.com/PaddlePaddle/Paddle), documents for [other PaddlePaddle projects](https://www.paddlepaddle.org.cn/overview) are being managed in their respective ways.
 
 ## Codebase structure
 

_typos.toml

@@ -32,11 +32,6 @@ Creenshot = "Creenshot"
 Embeddding = "Embeddding"
 Embeding = "Embeding"
 Engish = "Engish"
-Generater = "Generater"
-Gloabal = "Gloabal"
-Imporvement = "Imporvement"
-Interfce = "Interfce"
-Kernal = "Kernal"
 Learing = "Learing"
 Moible = "Moible"
 Operaton = "Operaton"
@@ -117,21 +112,8 @@ foward = "foward"
 functinal = "functinal"
 fundemental = "fundemental"
 funtion = "funtion"
-gard = "gard"
-generaly = "generaly"
-gloabl = "gloabl"
-heigh = "heigh"
 ilter = "ilter"
-imge = "imge"
-implememted = "implememted"
-indeces = "indeces"
-indentical = "indentical"
-indicies = "indicies"
-indx = "indx"
-infered = "infered"
 inferface = "inferface"
-infor = "infor"
-ingore = "ingore"
 instert = "instert"
 instrinsics = "instrinsics"
 interchangable = "interchangable"

docs/api/gen_doc.py

@@ -319,7 +319,7 @@ def parse_module_file(mod):
                                 )
                             if isinstance(node, ast.FunctionDef):
                                 api_info_dict[obj_id]["args"] = (
-                                    gen_functions_args_str(node)
+                                    gen_function_args_string(node)
                                 )
                             elif isinstance(node, ast.ClassDef):
                                 for n in node.body:
@@ -328,7 +328,7 @@ def parse_module_file(mod):
                                         and n.name == "__init__"
                                     ):
                                         api_info_dict[obj_id]["args"] = (
-                                            gen_functions_args_str(n)
+                                            gen_function_args_string(n)
                                         )
                                         break
                         else:
@@ -361,39 +361,62 @@ def parse_module_file(mod):
                             logger.debug("%s omitted", obj_full_name)
 
 
-def gen_functions_args_str(node):
-    str_args_list = []
-    if isinstance(node, ast.FunctionDef):
-        # 'args', 'defaults', 'kw_defaults', 'kwarg', 'kwonlyargs', 'posonlyargs', 'vararg'
-        for arg in node.args.args:
-            if not arg.arg == "self":
-                str_args_list.append(arg.arg)
+def gen_function_args_string(fn_node: ast.FunctionDef) -> str:
+    def _gen_default_value_string(default_node: ast.expr) -> str:
+        if isinstance(default_node, ast.Constant):
+            default_value = default_node.value
+            if isinstance(default_value, str):
+                return f"'{default_value}'"
+            return str(default_value)
+        elif isinstance(default_node, ast.Name):
+            return default_node.id
+        return "..."
 
-        defarg_ind_start = len(str_args_list) - len(node.args.defaults)
-        for defarg_ind in range(len(node.args.defaults)):
-            if isinstance(node.args.defaults[defarg_ind], ast.Name):
-                str_args_list[defarg_ind_start + defarg_ind] += "=" + str(
-                    node.args.defaults[defarg_ind].id
-                )
-            elif isinstance(node.args.defaults[defarg_ind], ast.Constant):
-                defarg_val = str(node.args.defaults[defarg_ind].value)
-                if isinstance(node.args.defaults[defarg_ind].value, str):
-                    defarg_val = f"'{defarg_val}'"
-                str_args_list[defarg_ind_start + defarg_ind] += "=" + defarg_val
-        if node.args.vararg is not None:
-            str_args_list.append("*" + node.args.vararg.arg)
-        if len(node.args.kwonlyargs) > 0:
-            if node.args.vararg is None:
-                str_args_list.append("*")
-            for kwoarg, d in zip(node.args.kwonlyargs, node.args.kw_defaults):
-                if isinstance(d, ast.Constant):
-                    str_args_list.append(f"{kwoarg.arg}={d.value}")
-                elif isinstance(d, ast.Name):
-                    str_args_list.append(f"{kwoarg.arg}={d.id}")
-        if node.args.kwarg is not None:
-            str_args_list.append("**" + node.args.kwarg.arg)
-
-    return ", ".join(str_args_list)
+    def _is_self_arg(arg: ast.arg) -> bool:
+        return arg.arg == "self"
+
+    if not isinstance(fn_node, ast.FunctionDef):
+        logger.warning(
+            "The provided node %s is not a FunctionDef.", ast.unparse(fn_node)
+        )
+        return ""
+    arg_list = []
+    posonlyargs_count = len(fn_node.args.posonlyargs)
+    # posonlyargs and args
+    defaults_start_index = (
+        len(fn_node.args.args)
+        + len(fn_node.args.posonlyargs)
+        - len(fn_node.args.defaults)
+    )
+    for i, arg in enumerate(fn_node.args.posonlyargs + fn_node.args.args):
+        if _is_self_arg(arg) and i == 0:
+            continue
+        if i == posonlyargs_count and posonlyargs_count > 0:
+            arg_list.append("/")
+        if i >= defaults_start_index:
+            default_value_str = _gen_default_value_string(
+                fn_node.args.defaults[i - defaults_start_index]
+            )
+            arg_list.append(f"{arg.arg}={default_value_str}")
+        else:
+            arg_list.append(arg.arg)
+    # vararg
+    if fn_node.args.vararg:
+        arg_list.append(f"*{fn_node.args.vararg.arg}")
+    # kwonlyargs
+    if fn_node.args.kwonlyargs:
+        arg_list.append("*")
+    for i, kwonlyarg in enumerate(fn_node.args.kwonlyargs):
+        kwdefault = fn_node.args.kw_defaults[i]
+        if kwdefault is None:
+            arg_list.append(kwonlyarg.arg)
+        else:
+            default_value_str = _gen_default_value_string(kwdefault)
+            arg_list.append(f"{kwonlyarg.arg}={default_value_str}")
+    # kwarg
+    if fn_node.args.kwarg:
+        arg_list.append(f"**{fn_node.args.kwarg.arg}")
+    return ", ".join(arg_list)
 
 
 # step 2 fill field : `display`

docs/api/paddle/nn/Upsample_cn.rst

@@ -154,7 +154,7 @@ https://en.wikipedia.org/wiki/Bicubic_interpolation
     - **scale_factor** (float|Tensor|list|tuple|None，可选) - 输入的深度、高度或宽度的缩放因子。:code:`size` 和 :code:`scale_factor` 至少要设置一个。:code:`size` 的优先级高于 :code:`scale_factor`。默认值为 None。如果 scale_factor 是一个 list 或 tuple，它必须与输入的 shape 匹配。
     - **mode** (str，可选) - 插值方法。支持"bilinear"或"trilinear"或"nearest"或"bicubic"或"linear"或"area"。默认值为"nearest"。
     - **align_corners** (bool，可选) - 一个可选的 bool 型参数，如果为 True，则将输入和输出 Tensor 的 4 个角落像素的中心对齐，并保留角点像素的值。默认值为 False。
-    - **align_mode** (int，可选) - 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_indx + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。默认值为 0。
+    - **align_mode** (int，可选) - 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_index + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。默认值为 0。
     - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致。支持的值有："NCW"、"NWC"、"NCHW"、"NHWC"、"NCDHW"、"NDHWC"。默认值为 None，此时若输入是 3-D Tensor， ``data_format`` 将默认为"NCW"；若输入是 4—D Tensor, 将默认为"NCHW"；若输入是 5—D Tensor, 将默认为"NCDHW"。
     - **recompute_scale_factor** (bool，可选) - 是否在插值计算中重新计算乘数因子。当设置为 True 时，必须提供 scale_factor 参数，函数会用 scale_factor 和输入张量的形状计算输出张量的形状，然后根据输出张量形状和输入张量形状重新计算乘数因子。该参数可用于 scale_factor 为浮点数的情况。当设置为 False 时，将直接使用 size 或 scale_factor 进行插值计算，不进行重新计算。默认值为 None。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

docs/api/paddle/nn/functional/interpolate_cn.rst

@@ -146,7 +146,7 @@ https://en.wikipedia.org/wiki/Bicubic_interpolation
     - **scale_factor** (float|Tensor|list|tuple|None)-输入的高度或宽度的乘数因子。out_shape 和 scale 至少要设置一个。out_shape 的优先级高于 scale。默认值为 None。如果 scale_factor 是一个 list 或 tuple，它必须与输入的 shape 匹配。
     - **mode** (str，可选) - 插值方法。支持"bilinear"或"trilinear"或"nearest"或"bicubic"或"linear"或"area"。默认值为"nearest"。
     - **align_corners** (bool，可选) - 一个可选的 bool 型参数，如果为 True，则将输入和输出 Tensor 的 4 个角落像素的中心对齐，并保留角点像素的值。默认值为 False。
-    - **align_mode** (int，可选) - 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_indx + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。默认值：0。
+    - **align_mode** (int，可选) - 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_index + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。默认值：0。
     - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致。支持的值有："NCW"、"NWC"、"NCHW"、"NHWC"、"NCDHW"、"NDHWC"。默认值为 None，此时若输入是 3-D Tensor， ``data_format`` 将默认为"NCW"；若输入是 4—D Tensor, 将默认为"NCHW"；若输入是 5—D Tensor, 将默认为"NCDHW"。
     - **recompute_scale_factor** (bool，可选) - 是否在插值计算中重新计算乘数因子。当设置为 True 时，必须提供 scale_factor 参数，函数会用 scale_factor 和输入张量的形状计算输出张量的形状，然后根据输出张量形状和输入张量形状重新计算乘数因子。该参数可用于 scale_factor 为浮点数的情况。当设置为 False 时，将直接使用 size 或 scale_factor 进行插值计算，不进行重新计算。默认值为 None。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

docs/api/paddle/nn/functional/upsample_cn.rst

@@ -144,7 +144,7 @@ https://en.wikipedia.org/wiki/Bicubic_interpolation
     - **size** (list|tuple|Tensor|None) - 输出 Tensor，输入为 4D Tensor 时，形状为为(out_h, out_w)的 2-D Tensor。输入为 5-D Tensor 时，形状为(out_d, out_h, out_w)的 3-D Tensor。如果 :code:`out_shape` 是列表，每一个元素可以是整数或者形状为[]的变量。如果 :code:`out_shape` 是变量，则其维度大小为 1。默认值为 None。
     - **scale_factor** (float|Tensor|list|tuple|None)-输入的高度或宽度的乘数因子。out_shape 和 scale 至少要设置一个。out_shape 的优先级高于 scale。默认值为 None。如果 scale_factor 是一个 list 或 tuple，它必须与输入的 shape 匹配。
     - **mode** (str，可选) - 插值方法。支持"bilinear"或"trilinear"或"nearest"或"bicubic"或"linear"或"area"。默认值为"nearest"。
-    - **align_mode** (int，可选)- 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_indx + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。
+    - **align_mode** (int，可选)- 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_index + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。
     - **align_corners** (bool，可选) - 一个可选的 bool 型参数，如果为 True，则将输入和输出 Tensor 的 4 个角落像素的中心对齐，并保留角点像素的值。默认值为 True
     - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致。支持的值有："NCW"、"NWC"、"NCHW"、"NHWC"、"NCDHW"、"NDHWC"。默认值为 None，此时若输入是 3-D Tensor， ``data_format`` 将默认为"NCW"；若输入是 4—D Tensor, 将默认为"NCHW"；若输入是 5—D Tensor, 将默认为"NCDHW"。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

docs/api/paddle/put_along_axis_cn.rst

@@ -21,7 +21,7 @@ put_along_axis
 返回
 :::::::::
 
-输出 Tensor，indeces 矩阵选定的下标会被插入 value，与 ``arr`` 数据类型相同。
+输出 Tensor，indices 矩阵选定的下标会被插入 value，与 ``arr`` 数据类型相同。
 
 代码示例
 :::::::::

docs/api/paddle/sparse/nn/functional/subm_conv2d_cn.rst

@@ -32,7 +32,7 @@ subm_conv2d
     - stride (int|list|tuple, optional): 步长大小， 意味着卷积的步长。如果步长为 list/tuple, 它必须包含两个整数 (stride_height, stride_width)。否则, stride_height = stride_width = stride。stride 的默认值为 1。
     - padding (string|int|list|tuple, optional): 填充大小。它表示零填充在每个维度的两侧的数量。
       如果 'padding' 是字符串，则 'VALID' 或 'SAME' 是填充算法。
-      如果填充大小是元组或列表，它可以有三种形式：'[pad_heigh, pad_width]' 或 '[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]'。
+      如果填充大小是元组或列表，它可以有三种形式：'[pad_height, pad_width]' 或 '[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]'。
       当 'data_format' 为 'NHWC' 时, 'padding' 可以采用以下形式 '[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]'。padding 的默认值为 0。
     - dilation (int|list|tuple, optional): 空洞大小。它表示内核点之间的间距。
       如果 dilation 是列表/元组，则它必须包含两个整数 (dilation_height、dilation_width)。

docs/api/paddle/take_along_axis_cn.rst

@@ -23,7 +23,7 @@ take_along_axis
 返回
 :::::::::
 
-输出 Tensor，包含 indeces 矩阵选定的元素，与 ``arr`` 数据类型相同。
+输出 Tensor，包含 indices 矩阵选定的元素，与 ``arr`` 数据类型相同。
 
 代码示例
 :::::::::

docs/api/paddle/vision/ops/decode_jpeg_cn.rst

@@ -19,7 +19,7 @@ decode_jpeg
 返回
 :::::::::
 
-    具有形状（imge_channels、image_height、image_width）的解码图像 Tensor。
+    具有形状（image_channels、image_height、image_width）的解码图像 Tensor。
 
 代码示例
 :::::::::