Merge branch 'cuda_apis_2' of github.com:fxyfxy777/docs into cuda_apis_2

Author: fxyfxy777

_typos.toml

@@ -25,64 +25,19 @@ arange = "arange"
 unsupport = "unsupport"
 Nervana = "Nervana"
 datas = "datas"
+feeded = "feeded"
 
 # These words need to be fixed
-Creenshot = "Creenshot"
 Learing = "Learing"
-Moible = "Moible"
 Operaton = "Operaton"
 Optimizaing = "Optimizaing"
 Optimzier = "Optimzier"
 Setment = "Setment"
-Similarily = "Similarily"
 Simle = "Simle"
 Sovler = "Sovler"
-Successed = "Successed"
-desgin = "desgin"
-desginated = "desginated"
-desigin = "desigin"
-determinated = "determinated"
-diffcult = "diffcult"
-dimention = "dimention"
-dimentions = "dimentions"
-dirrectories = "dirrectories"
-disucssion = "disucssion"
-feeded = "feeded"
-flaot = "flaot"
-fliters = "fliters"
-follwing = "follwing"
-formated = "formated"
-formater = "formater"
-forword = "forword"
-foward = "foward"
-functinal = "functinal"
-fundemental = "fundemental"
-funtion = "funtion"
-ilter = "ilter"
-inferface = "inferface"
-infor = "infor"
-instert = "instert"
-instrinsics = "instrinsics"
-interchangable = "interchangable"
-intializers = "intializers"
-intput = "intput"
-lable = "lable"
-learing = "learing"
-legth = "legth"
-lenth = "lenth"
-leran = "leran"
 libary = "libary"
-mantained = "mantained"
 matrics = "matrics"
-mdule = "mdule"
-mechnism = "mechnism"
-memeory = "memeory"
-memroy = "memroy"
-messege = "messege"
-metaphore = "metaphore"
 metrices = "metrices"
-muliply = "muliply"
-mulitplying = "mulitplying"
 mutbale = "mutbale"
 occurence = "occurence"
 opeartor = "opeartor"
@@ -93,11 +48,7 @@ outpu = "outpu"
 outpus = "outpus"
 overrided = "overrided"
 overwrited = "overwrited"
-porcess = "porcess"
-processer = "processer"
-sacle = "sacle"
 samle = "samle"
-satifies = "satifies"
 schedual = "schedual"
 secenarios = "secenarios"
 sematic = "sematic"

ci_scripts/CAPItools/utils_helper.py

@@ -219,7 +219,7 @@ def decode(self):
         # 避免空函数解析
         self.init_func = self.class_name
 
-        self.functions_infor = []
+        self.functions_info = []
         # Note: 未来可能在private也有函数
         # Note: 函数内构造函数可能解析有问题，需要后期查验
         self.class_function_number = len(self.class_dict["methods"]["public"])
@@ -267,7 +267,7 @@ def decode(self):
                             "param_intro"
                         ][param_name]
 
-            self.functions_infor.append(
+            self.functions_info.append(
                 {
                     "name": function_name,
                     "doxygen": funcs_intro,
@@ -322,46 +322,48 @@ def create_and_write_file_cn(self, save_dir, language):
                 )
                 f.write(class_function_head_text)
 
-                for fun_infor in self.functions_infor:
-                    if fun_infor["template"] == "":
+                for fun_info in self.functions_info:
+                    if fun_info["template"] == "":
                         fun_name_and_intro_text = ""
                     else:
-                        fun_name_and_intro_text = f"{fun_infor['template']}\n"
+                        fun_name_and_intro_text = f"{fun_info['template']}\n"
                     fun_name_and_intro_text += (
-                        f"{fun_infor['name']}\n"
+                        f"{fun_info['name']}\n"
                         + "'''''''''''\n"
-                        + f"{fun_infor['doxygen']}\n"
+                        + f"{fun_info['doxygen']}\n"
                         + "\n"
                     )
                     f.write(fun_name_and_intro_text)
 
-                    if fun_infor["note"] != "":
+                    if fun_info["note"] != "":
                         fun_note_text = (
-                            "..note::\n" + f"\t{fun_infor['note']}\n" + "\n"
+                            "..note::\n" + f"\t{fun_info['note']}\n" + "\n"
                         )
                         f.write(fun_note_text)
 
-                    if len(fun_infor["parameter"]) != 0:
+                    if len(fun_info["parameter"]) != 0:
                         parameters_text = "**参数**\n" + "'''''''''''\n"
                         f.write(parameters_text)
-                        for param in fun_infor["parameter"].keys():
+                        for param in fun_info["parameter"].keys():
                             param_text = f"\t- **{param}**"
-                            if fun_infor["parameter"][param]["type"] != "":
-                                param_text += f" ({fun_infor['parameter'][param]['type']})"
-                            if fun_infor["parameter"][param]["intro"] != "":
-                                param_text += f" - {fun_infor['parameter'][param]['intro']}"
+                            if fun_info["parameter"][param]["type"] != "":
+                                param_text += (
+                                    f" ({fun_info['parameter'][param]['type']})"
+                                )
+                            if fun_info["parameter"][param]["intro"] != "":
+                                param_text += f" - {fun_info['parameter'][param]['intro']}"
                             param_text += "\n"
                             f.write(param_text)
                     f.write("\n")
 
                     if (
-                        fun_infor["returns"] != ""
-                        and "void" not in fun_infor["returns"]
+                        fun_info["returns"] != ""
+                        and "void" not in fun_info["returns"]
                     ):
                         fun_return_text = (
                             "**返回**\n"
                             + "'''''''''''\n"
-                            + f"{fun_infor['returns']}\n"
+                            + f"{fun_info['returns']}\n"
                             + "\n"
                         )
                         f.write(fun_return_text)
@@ -399,46 +401,48 @@ def create_and_write_file_en(self, save_dir, language):
                 )
                 f.write(class_function_head_text)
 
-                for fun_infor in self.functions_infor:
-                    if fun_infor["template"] == "":
+                for fun_info in self.functions_info:
+                    if fun_info["template"] == "":
                         fun_name_and_intro_text = ""
                     else:
-                        fun_name_and_intro_text = f"{fun_infor['template']}\n"
+                        fun_name_and_intro_text = f"{fun_info['template']}\n"
                     fun_name_and_intro_text += (
-                        f"{fun_infor['name']}\n"
+                        f"{fun_info['name']}\n"
                         + "'''''''''''\n"
-                        + f"{fun_infor['doxygen']}\n"
+                        + f"{fun_info['doxygen']}\n"
                         + "\n"
                     )
                     f.write(fun_name_and_intro_text)
 
-                    if fun_infor["note"] != "":
+                    if fun_info["note"] != "":
                         fun_note_text = (
-                            "..note::\n" + f"\t{fun_infor['note']}\n" + "\n"
+                            "..note::\n" + f"\t{fun_info['note']}\n" + "\n"
                         )
                         f.write(fun_note_text)
 
-                    if len(fun_infor["parameter"]) != 0:
+                    if len(fun_info["parameter"]) != 0:
                         parameters_text = "**Parameters**\n" + "'''''''''''\n"
                         f.write(parameters_text)
-                        for param in fun_infor["parameter"].keys():
+                        for param in fun_info["parameter"].keys():
                             param_text = f"\t- **{param}**"
-                            if fun_infor["parameter"][param]["type"] != "":
-                                param_text += f" ({fun_infor['parameter'][param]['type']})"
-                            if fun_infor["parameter"][param]["intro"] != "":
-                                param_text += f" - {fun_infor['parameter'][param]['intro']}"
+                            if fun_info["parameter"][param]["type"] != "":
+                                param_text += (
+                                    f" ({fun_info['parameter'][param]['type']})"
+                                )
+                            if fun_info["parameter"][param]["intro"] != "":
+                                param_text += f" - {fun_info['parameter'][param]['intro']}"
                             param_text += "\n"
                             f.write(param_text)
                     f.write("\n")
 
                     if (
-                        fun_infor["returns"] != ""
-                        and "void" not in fun_infor["returns"]
+                        fun_info["returns"] != ""
+                        and "void" not in fun_info["returns"]
                     ):
                         fun_return_text = (
                             "**Returns**\n"
                             + "'''''''''''\n"
-                            + f"{fun_infor['returns']}\n"
+                            + f"{fun_info['returns']}\n"
                             + "\n"
                         )
                         f.write(fun_return_text)

ci_scripts/hooks/pre-doc-compile.sh

@@ -120,3 +120,27 @@ else
     echo "ERROR: Generated API mapping file not found at $GENERATED_FILE"
     handle_failure
 fi
+
+python "${APIMAPPING_ROOT}/tools/validate_api_difference_format.py"
+
+# 获取上一条命令的退出状态码
+exit_code=$?
+
+# 根据退出状态码决定后续操作
+if [ $exit_code -eq 0 ]; then
+    echo "API DIFFERENCE FORMAT VALIDATE SUCCESS!"
+    # 在这里继续添加您需要执行的命令
+else
+    echo "ERROR: API DIFFERENCE FORMAT VALIDATE FAILURE! error code: $exit_code" >&2
+    exit 1
+fi
+
+python "${APIMAPPING_ROOT}/tools/validate_pytorch_api_mapping.py" --skip-url-check
+exit_code=$?
+
+if [ $exit_code -eq 0 ]; then
+    echo "PYTORCH API MAPPING VALIDATE SUCCESS!"
+else
+    echo "ERROR: PYTORCH API MAPPING VALIDATE FAILURE! error code: $exit_code" >&2
+    exit 1
+fi

docs/api/copy_codes_from_en_doc.py

@@ -237,7 +237,7 @@ def find_codeblock_needed(cf_info):
         return None
 
 
-def instert_codes_into_cn_rst_if_need(cnrstfilename):
+def insert_codes_into_cn_rst_if_need(cnrstfilename):
     """
     Analyse the cn rst file, if need, extract code-blocks from en docstring.
     """
@@ -290,7 +290,7 @@ def instert_codes_into_cn_rst_if_need(cnrstfilename):
 
 
 def filter_all_files(
-    rootdir, ext="_cn.rst", action=instert_codes_into_cn_rst_if_need
+    rootdir, ext="_cn.rst", action=insert_codes_into_cn_rst_if_need
 ):
     """
     find all the _en.html file, and do the action.

docs/api/paddle/compat/Overview_cn.rst

@@ -18,20 +18,33 @@ PyTorch 兼容函数
     " :ref:`median <cn_api_paddle_compat_median>` ", "兼容版中位数，支持 dim/keepdim/out 签名"
     " :ref:`min <cn_api_paddle_compat_min>` ", "包含 `amin`、同时返回 values 及 indices 的轴向最小值、`minimum` 三种功能"
     " :ref:`nanmedian <cn_api_paddle_compat_nanmedian>` ", "忽略 NaN 的兼容版中位数，支持 dim/keepdim/out 签名"
-    " :ref:`pad <cn_api_paddle_compat_pad>` ", "从最后一维度开始进行 padding、padding 正确兼容转换的填充函数"
     " :ref:`slogdet <cn_api_paddle_compat_slogdet>` ", "slogdet 函数"
-    " :ref:`softmax <cn_api_paddle_compat_softmax>` ", "softmax 函数"
     " :ref:`sort <cn_api_paddle_compat_sort>` ", "同时返回 values 及 indices 的排序"
     " :ref:`split <cn_api_paddle_compat_split>` ", "允许非整除块大小输入的 Tensor 轴向切分"
 
 
-.. _about_compat_class:
+.. _about_compat_nn:
 
-PyTorch 兼容模块
-::::::::::::::::::::
+PyTorch 兼容的 nn 模块
+::::::::::::::::::::::::::::::
 
 .. csv-table::
     :header: "类名称", "类功能"
     :widths: 10, 30
 
-    " :ref:`Unfold <cn_api_paddle_compat_Unfold>` ", "允许 Tensor 输入的 ``paddle.nn.Unfold`` 兼容版本"
+    " :ref:`Linear <cn_api_paddle_compat_nn_Linear>` ", "PyTorch 对齐的 ``paddle.nn.Linear`` 兼容版本"
+    " :ref:`Unfold <cn_api_paddle_compat_nn_Unfold>` ", "允许 Tensor 输入的 ``paddle.nn.Unfold`` 兼容版本"
+
+
+.. _about_compat_nn_functional:
+
+PyTorch 兼容的 nn.functional 模块
+::::::::::::::::::::::::::::::::::::::::
+
+.. csv-table::
+    :header: "函数名称", "函数功能"
+    :widths: 10, 30
+
+    " :ref:`linear <cn_api_paddle_compat_nn_functional_linear>` ", "PyTorch 对齐的 ``paddle.nn.functional.linear`` 兼容版本"
+    " :ref:`pad <cn_api_paddle_compat_nn_functional_pad>` ", "从最后一维度开始进行 padding、padding 正确兼容转换的填充函数"
+    " :ref:`softmax <cn_api_paddle_compat_nn_functional_softmax>` ", "softmax 函数"

docs/api/paddle/compat/max_cn.rst

@@ -9,7 +9,7 @@ max
 
     使用前请详细参考：`【返回参数类型不一致】torch.max`_ 以确定是否使用此模块。
 
-.. _【返回参数类型不一致】torch.max: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.max.html
+.. _【返回参数类型不一致】torch.max: https://www.paddlepaddle.org.cn/documentation/docs/en/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.max.html
 
 
 .. caution::

docs/api/paddle/compat/min_cn.rst

@@ -9,7 +9,7 @@ min
 
     使用前请详细参考：`【返回参数类型不一致】torch.min`_ 以确定是否使用此模块。
 
-.. _【返回参数类型不一致】torch.min: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.min.html
+.. _【返回参数类型不一致】torch.min: https://www.paddlepaddle.org.cn/documentation/docs/en/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.min.html
 
 
 .. caution::

docs/api/paddle/compat/nn_Linear_cn.rst

@@ -0,0 +1,45 @@
+.. _cn_api_paddle_compat_nn_Linear:
+
+Linear
+-------------------------------
+
+.. py:class:: paddle.compat.nn.Linear(in_features, out_features, bias, device=None, dtype=None)
+
+PyTorch 兼容的 :ref:`cn_api_paddle_nn_Linear` 版本：
+
+    - 与 PyTorch 一致的数学意义：
+
+    .. math::
+
+        Out = XW^T + b
+
+    其中 :math:`W` 是权重张量， :math:`b` 是偏置张量， :math:`X` 是输入张量
+
+    - 与 PyTorch 一致的默认可视化方法： Kaiming normal 用于权重初始化，平均分布用于偏置初始化
+    - 支持设定 ``Linear`` 的数据类型以及运行设备
+
+使用前请详细参考：`【仅参数名不一致】torch.nn.Linear`_ 以确定是否使用此模块。
+
+.. _【仅参数名不一致】torch.nn.Linear: https://www.paddlepaddle.org.cn/documentation/docs/en/guides/model_convert/convert_from_pytorch/api_difference/nn/torch.nn.Linear.html
+
+参数
+:::::::::::
+
+        - **in_features** (int) - 输入单元数。
+        - **out_features** (int) - 输出单元数。
+        - **bias** (bool, 可选) - 如果为 True，将创建偏置（一个形状为 :math:`[out\_features]` 的一维张量）并添加到输出。默认值 True。
+        - **device** (PlaceLike, 可选) - 创建参数所在的设备。默认值为 None，表示默认 Paddle 设备。
+        - **dtype** (DTypeLike, 可选) - 创建参数的数据类型。默认值为 None，并设置为 Linear 的默认数据类型（float32）。
+
+形状
+:::::::::
+
+        - **输入** : 多维张量，形状为 :math:`[*, in\_features]` 。数据类型为 float16、float32、float64，默认为 float32。
+        - **输出** : 多维张量，形状为 :math:`[*, out\_features]` 。数据类型与输入相同。
+
+
+
+代码示例
+::::::::::::
+
+COPY-FROM: paddle.compat.nn.Linear