补充GaussianNLLLoss中文文档。;test=docs_preview #5623

Atlantisming · 2023-02-22T08:05:14Z

代码及英文文档链接：PaddlePaddle/Paddle#50843
rfc文档链接：PaddlePaddle/community#446

…_branch

sunzhongkai588

整体错误较多，请仔细参考 api文档写作规范！！再进行修改

sunzhongkai588 · 2023-03-24T03:25:13Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

@@ -0,0 +1,40 @@
+.. _cn_api_paddle_nn_GaussianNLLLoss:
+
+SmoothL1Loss


SmoothL1Loss？是不是写错了

sunzhongkai588 · 2023-03-24T03:31:10Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+参数
+::::::::::
+
+    - **full** (bool) - 是否在损失计算中包括常数项。默认情况下为 False。


英文这边参数都有“可选”，即(bool，可选)，中英文请保持一致。下面的参数也同样注意

另外，请增加默认值为false代表什么意思，即 默认情况下为 False，代表...

sunzhongkai588 · 2023-03-24T03:32:40Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+::::::::::
+
+    - **full** (bool) - 是否在损失计算中包括常数项。默认情况下为 False。
+    - **epsilon** (float) - 用于限制 variance 的值，使其不会导致除 0 的出现。默认值为 1e-6


增加句号

sunzhongkai588 · 2023-03-24T03:33:06Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+
+    - **full** (bool) - 是否在损失计算中包括常数项。默认情况下为 False。
+    - **epsilon** (float) - 用于限制 variance 的值，使其不会导致除 0 的出现。默认值为 1e-6
+    - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有 ``none``、``mean`` 和 ``sum``。默认为 ``mean``，计算 ``mini-batch`` loss 均值。设置为 `sum` 时，计算 `mini-batch` loss 的总和。设置为 ``none`` 时，则返回 loss Tensor。


该行最后的 mini-batch 用双引号

sunzhongkai588 · 2023-03-24T03:35:16Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+    - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有 ``none``、``mean`` 和 ``sum``。默认为 ``mean``，计算 ``mini-batch`` loss 均值。设置为 `sum` 时，计算 `mini-batch` loss 的总和。设置为 ``none`` 时，则返回 loss Tensor。
+    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+输入


输入？应该是形状吧

sunzhongkai588 · 2023-03-24T03:36:19Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+
+    - **input** (Tensor)：输入 :attr:`Tensor`，其形状为 :math:`[N, *]`，其中 :math:`*` 表示任何数量的额外维度。
+    - **label** (Tensor)：输入 :attr:`Tensor`， 形状、数据类型和 :attr:`input` 相同。
+    - **variance** (Tensor): 输入 :attr:`Tensor`，形状和 :attr:`input` 相同。


这部分描述好像和英文没有一致？请再检查一遍，务必做到中英文描述是一致的

sunzhongkai588 · 2023-03-24T03:39:31Z

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

+-------------------------------
+.. py:function:: paddle.nn.functional.gaussian_nll_loss(input, label, variance, full=False, epsilon=1e-6, reduction='mean', name=None)
+
+返回 `gaussian negative log likelihood loss`。可在 :ref:`_cn_api_paddle_nn_GaussianNLLLoss` 查看详情。


:ref:_cn_api_paddle_nn_GaussianNLLLoss 引用方式不对， _cn_api_paddle_nn_GaussianNLLLoss 最前面的下划线应该去掉

参考： https://github.com/PaddlePaddle/docs/wiki/飞桨文档相互引用

sunzhongkai588 · 2023-03-24T03:47:40Z

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

@@ -0,0 +1,26 @@
+.. _cn_api_nn_functional_nll_loss:
+
+nll_loss


api名字也写错了吧？，应该是 gaussian_nll_loss

sunzhongkai588 · 2023-03-24T03:48:28Z

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

@@ -0,0 +1,26 @@
+.. _cn_api_nn_functional_nll_loss:


这样会造成误解，改成.. _cn_api_nn_functional_gaussian_nll_loss:

sunzhongkai588 · 2023-03-24T03:49:17Z

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

+代码示例
+:::::::::
+
+COPY-FROM: paddle.nn.functional.nll_loss


copy from也错了，应该是copy的是 gaussian_nll_loss 的代码

sunzhongkai588

除comment里提到的问题之外，还有两个内容需要补充

在 api_label 中加入新增的两个api的label（label是每格rst第一行去掉cn）
在paddle.nn下的overview中增加对GaaussianNLLLoss的描述，参考：
https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/nn/Overview_cn.html#loss-layers

sunzhongkai588 · 2023-03-28T04:05:06Z

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

+
+返回
+:::::::::
+`Tensor`，返回存储表示 `gaussian negative log likelihood loss` 的损失值。数据类型与:attr:`input`相同。当 reduction 为:attr:`none`时，形状与:attr:`input`相同。


:attr:input 左右增加空格，该行其他地方也有相同的错误

注意中英文间增加空格，否则代码风格的ci会过不了，尽量用 pre commmit工具自动检查下

sunzhongkai588 · 2023-03-28T07:17:56Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+.. py:class:: paddle.nn.GaussianNLLLoss(full=False, epsilon=1e-6, reduction='mean', name=None)
+
+计算输入 :attr:`input` 和标签 :attr:`label`、 :attr:`variance` 间的 GaussianNLL 损失，
+:attr:`label` 被视为高斯分布的样本，其期望和方差由神经网络预测给出。对于一个 :attr:`label` 张量建模为具有高斯分布的张量的期望值 :attr:`input` 和张量的正方差 :attr:`var`，数学计算公式如下：


总感觉这段话读起来不太通顺..尤其是最后一句 对于一个 label 张量建模为具有高斯分布的张量的期望值 input 和张量的正方差 var ，建议从头开始的整段描述再斟酌、优化一下

sunzhongkai588 · 2023-03-28T07:31:31Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+    \text{loss} = \frac{1}{2}\left(\log\left(\text{max}\left(\text{var},
+        \ \text{epsilon}\right)\right) + \frac{\left(\text{input} - \text{label}\right)^2}
+        {\text{max}\left(\text{var}, \ \text{epsilon}\right)}\right) + \text{const.}
+


在英文文档中还有如下描述，在中文文档中确实。按照中英文文档严格一致的要求，请添加相关描述～或者说清楚不一致的原因

sunzhongkai588 · 2023-03-28T07:35:57Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+::::::::::
+
+    - **input** (Tensor)：输入 :attr:`Tensor`，其形状为 :math:`(N, *)` 或者 :math:`(*)`，其中 :math:`*` 表示任何数量的额外维度。数据类型为 float32 或 float64。
+    - **label** (Tensor)：输入 :attr:`Tensor`，其形状为 :math:`(N, *)` 或者 :math:`(*)`，形状与 :attr:`input` 相同，或者其中一维的大小为 1，这时会进行 broadcast 操作。数据类型为 float32 或 float64。


“或者”后面的建议描述再清楚些，如或者形状与input相同但....

sunzhongkai588 · 2023-03-28T07:37:02Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+
+    - **input** (Tensor)：输入 :attr:`Tensor`，其形状为 :math:`(N, *)` 或者 :math:`(*)`，其中 :math:`*` 表示任何数量的额外维度。数据类型为 float32 或 float64。
+    - **label** (Tensor)：输入 :attr:`Tensor`，其形状为 :math:`(N, *)` 或者 :math:`(*)`，形状与 :attr:`input` 相同，或者其中一维的大小为 1，这时会进行 broadcast 操作。数据类型为 float32 或 float64。
+    - **variance** (Tensor): 输入 :attr:`Tensor`，其形状为 :math:`(N, *)` 或者 :math:`(*)`，形状与 :attr:`input` 相同，或其中一维的大小为 1，或缺少一维，这时会进行 broadcast 操作。数据类型为 float32 或 float64。


同样的，“或者”后面的描述建议清晰些

或缺少一维 这句话再斟酌一下，会造成误解

英文文档还有 output的形状描述，请统一

sunzhongkai588 · 2023-03-28T07:39:07Z

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

+参数
+:::::::::
+- **input** (Tensor)：输入 :attr:`Tensor`，其形状为 :math:`(N, *)` 或者 :math:`(*)`，其中 :math:`*` 表示任何数量的额外维度。将被拟合成为高斯分布。数据类型为 float32 或 float64。
+- **label** (Tensor)：输入 :attr:`Tensor`，其形状为 :math:`(N, *)` 或者 :math:`(*)`，形状、数据类型和 :attr:`input` 相同，或者其中一维的大小为 1，这时会进行 broadcast 操作。为服从高斯分布的样本。数据类型为 float32 或 float64。


同样的，按上述要求对“或者”后的描述更清晰化一些

sunzhongkai588

内容写的很好，还有一些写作typo需要修改一下～

sunzhongkai588 · 2023-04-07T03:22:23Z

docs/api/paddle/nn/Overview_cn.rst

@@ -258,6 +258,7 @@ Loss 层
    " :ref:`paddle.nn.MarginRankingLoss <cn_api_nn_loss_MarginRankingLoss>` ", "MarginRankingLoss 层"
    " :ref:`paddle.nn.MSELoss <cn_api_paddle_nn_MSELoss>` ", "均方差误差损失层"
    " :ref:`paddle.nn.NLLLoss <cn_api_nn_loss_NLLLoss>` ", "NLLLoss 层"
+    " :ref:`paddle.nn.GaussianNLLLoss <cn_api_nn_loss_GaussianNLLLoss>` ", "GaussianNLLLoss 层"


标签应当和 api/label 及相应api文档第一行标签一致

建议改为 cn_api_paddle_nn_GaussianNLLLoss

sunzhongkai588 · 2023-04-07T03:32:07Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

@@ -0,0 +1,44 @@
+.. _cn_api_nn_GaussianNLLLoss:


标签应当和 api/label 一致

建议改为 _cn_api_paddle_nn_GaussianNLLLoss

sunzhongkai588 · 2023-04-07T03:37:54Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+.. py:class:: paddle.nn.GaussianNLLLoss(full=False, epsilon=1e-6, reduction='mean', name=None)
+
+该接口创建一个 GaussianNLLLoss 实例，计算输入 :attr:`input` 和标签 :attr:`label`、 :attr:`variance` 间的 GaussianNLL 损失，
+:attr:`label` 被视为服从高斯分布的样本，其期望:attr:`input`和方差:attr:`variance`由神经网络预测给出。


请注意 attr 的写作规范，左右需要增加空格

sunzhongkai588 · 2023-04-07T03:41:08Z

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

+.. py:function:: paddle.nn.functional.gaussian_nll_loss(input, label, variance, full=False, epsilon=1e-6, reduction='mean', name=None)
+
+计算输入 :attr:`input` 、:attr:`variance` 和标签 :attr:`label` 间的 GaussianNLL 损失，
+:attr:`label` 被视为高斯分布的样本，其期望:attr:`input`和方差:attr:`variance`由神经网络预测给出。


同理，注意 attr 的写作规范，左右需要加空格

sunzhongkai588

请修改，注意细节！

sunzhongkai588 · 2023-04-10T08:21:14Z

docs/api/paddle/nn/GaussianNLLLoss_cn.rst

+.. py:class:: paddle.nn.GaussianNLLLoss(full=False, epsilon=1e-6, reduction='mean', name=None)
+
+该接口创建一个 GaussianNLLLoss 实例，计算输入 :attr:`input` 和标签 :attr:`label`、 :attr:`variance` 间的 GaussianNLL 损失，
+:attr:`label` 被视为服从高斯分布的样本，期望 :attr:`input` 和 方差:attr:`variance` 由神经网络预测给出。


:attr:variance 左边加空格

sunzhongkai588 · 2023-04-10T08:24:31Z

docs/api/paddle/nn/Overview_cn.rst

@@ -481,6 +482,7 @@ Embedding 相关函数
    " :ref:`paddle.nn.functional.margin_ranking_loss <cn_api_nn_cn_margin_ranking_loss>` ", "用于计算 margin rank loss 损失"
    " :ref:`paddle.nn.functional.mse_loss <cn_paddle_nn_functional_mse_loss>` ", "用于计算均方差误差"
    " :ref:`paddle.nn.functional.nll_loss <cn_api_nn_functional_nll_loss>` ", "用于计算 nll 损失"
+    " :ref:`paddle.nn.functional.gaussian_nll_loss <n_api_paddle_nn_functional_gaussian_nll_loss>` ", "用于计算 gaussiannll 损失"


n_api_paddle_nn_functional_gaussian_nll_loss 最前面少了个c吧？

sunzhongkai588 · 2023-04-10T08:27:15Z

docs/api/paddle/nn/Overview_cn.rst

@@ -258,6 +258,7 @@ Loss 层
    " :ref:`paddle.nn.MarginRankingLoss <cn_api_nn_loss_MarginRankingLoss>` ", "MarginRankingLoss 层"
    " :ref:`paddle.nn.MSELoss <cn_api_paddle_nn_MSELoss>` ", "均方差误差损失层"
    " :ref:`paddle.nn.NLLLoss <cn_api_nn_loss_NLLLoss>` ", "NLLLoss 层"
+    " :ref:`paddle.nn.GaussianNLLLoss <cn_api_paddle_nn_loss_GaussianNLLLoss>` ", "GaussianNLLLoss 层"


相应文档的rst第一行标签是 cn_api_paddle_nn_GaussianNLLLoss。中间没有loss，请修改

sunzhongkai588 · 2023-04-11T03:25:07Z

@Atlantisming 文档没有其他问题了，但该分支有个conflict需要解决下，初步看是因为之前有其他开发者新增了一个loss API，在overview里加了一行，刚好和你冲突了。拉取最新的代码解决即可～

补充GaussianNLLLoss中文文档。;test=docs_preview

1488c59

This was referenced Feb 22, 2023

【Hackathon 4th No.15】Add GaussianNLLLoss rfc file. PaddlePaddle/community#372

Merged

Gs loss branch PaddlePaddle/Paddle#50761

Closed

Add GaussianNLLLoss API. PaddlePaddle/Paddle#50843

Merged

补充GaussianNLLLoss中文文档。;test=docs_preview

5949db9

paddle-bot bot added the contributor label Feb 27, 2023

Atlantisming and others added 3 commits March 14, 2023 14:19

Merge branch 'PaddlePaddle:develop' into gauss_doc_branch

88cfd19

补充GaussianNLLLoss中文文档。;test=docs_preview

6ed290b

Merge remote-tracking branch 'origin/gauss_doc_branch' into gauss_doc…

221f9bd

…_branch

sunzhongkai588 reviewed Mar 24, 2023

View reviewed changes

补充GaussianNLLLoss中文文档。; test=docs_preview

ed41652

luotao1 assigned luotao1 and sunzhongkai588 Mar 28, 2023

sunzhongkai588 reviewed Mar 28, 2023

View reviewed changes

补充GaussianNLLLoss对shape的描述。; test=docs_preview

996c173

sunzhongkai588 reviewed Apr 7, 2023

View reviewed changes

补充GaussianNLLLoss对shape的描述。; test=docs_preview

811c9cf

sunzhongkai588 reviewed Apr 10, 2023

View reviewed changes

修改显示错误。; test=docs_preview

0b9b5b4

Merge branch 'develop' into gauss_doc_branch

75b8934

luotao1 approved these changes Apr 13, 2023

View reviewed changes

luotao1 merged commit a63f288 into PaddlePaddle:develop Apr 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

补充GaussianNLLLoss中文文档。;test=docs_preview #5623

补充GaussianNLLLoss中文文档。;test=docs_preview #5623

Atlantisming commented Feb 22, 2023 •

edited

Loading

sunzhongkai588 left a comment

sunzhongkai588 Mar 24, 2023

sunzhongkai588 Mar 24, 2023

sunzhongkai588 Mar 24, 2023

sunzhongkai588 Mar 24, 2023

sunzhongkai588 Mar 24, 2023

sunzhongkai588 Mar 24, 2023

sunzhongkai588 Mar 24, 2023

sunzhongkai588 Mar 24, 2023

sunzhongkai588 Mar 24, 2023

sunzhongkai588 Mar 24, 2023

sunzhongkai588 left a comment

sunzhongkai588 Mar 28, 2023

sunzhongkai588 Mar 28, 2023

sunzhongkai588 Mar 28, 2023

sunzhongkai588 Mar 28, 2023

sunzhongkai588 Mar 28, 2023

sunzhongkai588 Mar 28, 2023

sunzhongkai588 left a comment

sunzhongkai588 Apr 7, 2023

sunzhongkai588 Apr 7, 2023

sunzhongkai588 Apr 7, 2023

sunzhongkai588 Apr 7, 2023

sunzhongkai588 left a comment

sunzhongkai588 Apr 10, 2023

sunzhongkai588 Apr 10, 2023

sunzhongkai588 Apr 10, 2023

sunzhongkai588 commented Apr 11, 2023

		@@ -0,0 +1,40 @@
		.. _cn_api_paddle_nn_GaussianNLLLoss:

		SmoothL1Loss

补充GaussianNLLLoss中文文档。;test=docs_preview #5623

补充GaussianNLLLoss中文文档。;test=docs_preview #5623

Conversation

Atlantisming commented Feb 22, 2023 • edited Loading

sunzhongkai588 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunzhongkai588 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunzhongkai588 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunzhongkai588 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunzhongkai588 commented Apr 11, 2023

Atlantisming commented Feb 22, 2023 •

edited

Loading