Docathon][Add CN Doc No.56-57] #6358

zade23 · 2023-12-07T07:49:52Z

PR types

Others

PR changes

Docs

Description

中文文档添加任务

#6193

新增中文文档：

fused_bias_dropout_residual_layer_norm
FusedBiasDropoutResidualLayerNorm

英文文档链接：

序号	API名称	英文文档地址
56	paddle.incubate.nn.functional.fused_bias_dropout_residual_layer_norm	https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_en.html
57	paddle.incubate.nn.FusedBiasDropoutResidualLayerNorm	https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_en.html

@ZzSean @sunzhongkai588

paddle-bot · 2023-12-07T07:50:01Z

感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-6358.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明，请参考：飞桨文档预览工具

paddle-bot · 2023-12-07T07:50:11Z

感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-6358.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明，请参考：飞桨文档预览工具

Vvsmile

请修改Review处，非常感谢您的贡献！

Vvsmile · 2024-01-17T03:04:26Z

docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst

+
+.. py:function:: paddle.incubate.nn.functional.fused_bias_dropout_residual_layer_norm(x, residual, bias=None, ln_scale=None, ln_bias=None, dropout_rate=0.5, ln_epsilon=1e-05, training=True, mode='upscale_in_train', name=None)
+
+融合偏置、Dropout 和残差层归一化操作符。其伪代码如下：


”融合偏置、Dropout 和残差层归一化“不需要翻译，直接饮用原操作符名。如改为“fused_bias_dropout_residual_layer_norm操作符。”

若想增加功能介绍，可修为形式 ”fused_bias_dropout_residual_layer_norm操作符，包含融合偏置、Dropout 和残差层归一化。“

Done
修改前：融合偏置、Dropout 和残差层归一化操作符。
修改后：fused_bias_dropout_residual_layer_norm 操作符，包含融合偏置、Dropout 和残差层归一化。

Vvsmile · 2024-01-17T03:10:11Z

docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst

+    - **dropout_rate** (float，可选) - 在注意力权重上使用的 Dropout 概率，用于在注意力后的 Dropout 过程中丢弃一些注意力目标。0 表示无 Dropout。默认为 0.5。
+    - **ln_epsilon** (float，可选) - 在层归一化的分母中添加的小浮点数，用于避免除以零。默认为 1e-5。
+    - **training** (bool，可选) - 表示是否处于训练阶段的标志。默认为 True。
+    - **mode** (str，可选) - ['upscale_in_train'(默认) | 'downscale_in_infer']，有两种模式：


“有两种模式” -> "两种模式分别为："

Vvsmile · 2024-01-17T03:14:59Z

docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst

+
+.. py:class:: paddle.incubate.nn.FusedBiasDropoutResidualLayerNorm(embed_dim, dropout_rate=0.5, weight_attr=None, bias_attr=None, epsilon=1e-05, name=None)
+
+应用融合偏置、Dropout 和残差层归一化操作。


使用原算子名，无需翻译，如果要解释操作，请在后续补充。
推荐修改为
”应用fused_bias_dropout_residual_layer_norm操作符，包含融合偏置、Dropout 和残差层归一化操作。“

Done
修改前：应用融合偏置、Dropout 和残差层归一化操作。
修改后：应用fused_bias_dropout_residual_layer_norm操作符，包含融合偏置、Dropout 和残差层归一化操作。

Vvsmile · 2024-01-17T03:19:01Z

docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst

+                                 2. downscale_in_infer，在推理时下调输出
+                                    - 训练：out = input * mask
+                                    - 推理：out = input * (1.0 - p)
+    - **name** (str，可选) - 操作的名称（可选，默认为 None）。更多信息，请参考：ref:`api_guide_Name`。


此处的“：ref:api_guide_Name” 同FusedBiasDropoutResidualLayerNorm（上一处填充）中文文档中的“: ref:cn_api_paddle_ParamAttr” 不一致，请统一格式

@Vvsmile 开发者您好
关于这两处引用的格式，可能是正确的。
我在中文文档中找到了同时引用(Name 和 ParamAttr)的文档FusedMultiHeadAttention。

若是我理解错您的意思了，或有其他方面的修改需求，烦请更新Review

细节问题，统一一下ref前是中文冒号还是英文冒号，表述不清引起的额外工作量，烦请见谅

细节问题，统一一下ref前是中文冒号还是英文冒号

了解了，目前修改中已经统一使用英文冒号了

Vvsmile · 2024-01-17T03:24:17Z

docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst

+
+COPY-FROM: paddle.incubate.nn.FusedBiasDropoutResidualLayerNorm
+
+forward(src, src_mask=None, cache=None)


此处和英文文档无法对应，请再次确定来源是否有误

应修改为forward(x, residual)，代码中也是此格式，请本人也重新确认一下。

Done
已确认，错误表述可能是翻译时函数对应错误。
修改为：forward(x, residual)

Vvsmile · 2024-01-17T03:24:34Z

docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst

+
+forward(src, src_mask=None, cache=None)
+::::::::::::
+应用融合偏置、Dropout 和残差层归一化操作。


使用原算子名，无需翻译，如果要解释操作，请在后续补充。
推荐修改为
”应用fused_bias_dropout_residual_layer_norm操作符，包含融合偏置、Dropout 和残差层归一化操作。“

Done
修改前：应用融合偏置、Dropout 和残差层归一化操作。
修改后：应用fused_bias_dropout_residual_layer_norm操作符，包含融合偏置、Dropout 和残差层归一化操作。

Vvsmile · 2024-01-17T03:28:34Z

docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst

+
+返回
+::::::::::::
+Tensor|tuple：数据类型与 ``x`` 一样。


根据英文文档应翻译为 “与x具有相同数据类型和形状的张量”

Vvsmile · 2024-01-17T03:32:39Z

docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst

+
+extra_repr()
+::::::::::::
+返回当前层的额外信息。


根据英文文档应翻译为“当前层的额外表示，可以有使用者建立的层的自定义实现”（可以想一下更好的翻译）

Done
修改前：返回当前层的额外信息。
修改为：当前层的额外表示，您可以自定义实现自己的层。

Vvsmile · 2024-01-17T06:48:59Z

LGTM

docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst

…dual_layer_norm_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>

sunzhongkai588

好像得用 pre-commit 再跑一下

zade23 · 2024-01-17T07:57:41Z

好像得用 pre-commit 再跑一下

Done

sunzhongkai588

LGTM

add docs

fb40183

paddle-bot bot added the contributor label Dec 7, 2023

luotao1 mentioned this pull request Dec 7, 2023

【Docathon】补充缺失的中文 API 文档 #6193

Closed

luotao1 added the HappyOpenSource 快乐开源活动issue与PR label Dec 8, 2023

luotao1 assigned luotao1 and sunzhongkai588 Dec 8, 2023

zade23 mentioned this pull request Dec 8, 2023

[WeeklyReports] 2023.11.26~2023.12.10 周报收集 PFCCLab/Starter#37

Closed

26 tasks

luotao1 assigned Vvsmile Jan 15, 2024

Vvsmile reviewed Jan 17, 2024

View reviewed changes

zade23 and others added 2 commits January 17, 2024 11:51

Merge branch 'PaddlePaddle:develop' into en_doc_5657

31d53df

fix doc issues

358b214

zade23 requested a review from Vvsmile January 17, 2024 06:27

sunzhongkai588 reviewed Jan 17, 2024

View reviewed changes

docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst Outdated Show resolved Hide resolved

docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst Outdated Show resolved Hide resolved

zade23 and others added 2 commits January 17, 2024 15:14

Update docs/api/paddle/incubate/nn/functional/fused_bias_dropout_resi…

1f88fa8

…dual_layer_norm_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>

Update docs/api/paddle/incubate/nn/functional/fused_bias_dropout_resi…

3f8be7e

…dual_layer_norm_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>

sunzhongkai588 reviewed Jan 17, 2024

View reviewed changes

rerun pre-commit

6c6f0cf

sunzhongkai588 approved these changes Jan 17, 2024

View reviewed changes

luotao1 merged commit e587b96 into PaddlePaddle:develop Jan 17, 2024
2 checks passed

zade23 deleted the en_doc_5657 branch January 17, 2024 08:52

zade23 mentioned this pull request Jan 22, 2024

[WeeklyReports] 2023.12.25~2024.1.19 周报收集 PFCCLab/Starter#97

Closed

24 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docathon][Add CN Doc No.56-57] #6358

Docathon][Add CN Doc No.56-57] #6358

zade23 commented Dec 7, 2023

paddle-bot bot commented Dec 7, 2023

paddle-bot bot commented Dec 7, 2023

Vvsmile left a comment

Vvsmile Jan 17, 2024

zade23 Jan 17, 2024

Vvsmile Jan 17, 2024

zade23 Jan 17, 2024

Vvsmile Jan 17, 2024

zade23 Jan 17, 2024

Vvsmile Jan 17, 2024

zade23 Jan 17, 2024

Vvsmile Jan 17, 2024 •

edited

Loading

zade23 Jan 17, 2024

Vvsmile Jan 17, 2024

Vvsmile Jan 17, 2024

zade23 Jan 17, 2024

Vvsmile Jan 17, 2024

zade23 Jan 17, 2024

Vvsmile Jan 17, 2024

zade23 Jan 17, 2024

Vvsmile Jan 17, 2024

zade23 Jan 17, 2024

Vvsmile commented Jan 17, 2024

sunzhongkai588 left a comment

zade23 commented Jan 17, 2024

sunzhongkai588 left a comment


		.. py:function:: paddle.incubate.nn.functional.fused_bias_dropout_residual_layer_norm(x, residual, bias=None, ln_scale=None, ln_bias=None, dropout_rate=0.5, ln_epsilon=1e-05, training=True, mode='upscale_in_train', name=None)

		融合偏置、Dropout 和残差层归一化操作符。其伪代码如下：


		.. py:class:: paddle.incubate.nn.FusedBiasDropoutResidualLayerNorm(embed_dim, dropout_rate=0.5, weight_attr=None, bias_attr=None, epsilon=1e-05, name=None)

		应用融合偏置、Dropout 和残差层归一化操作。


		COPY-FROM: paddle.incubate.nn.FusedBiasDropoutResidualLayerNorm

		forward(src, src_mask=None, cache=None)

Docathon][Add CN Doc No.56-57] #6358

Docathon][Add CN Doc No.56-57] #6358

Conversation

zade23 commented Dec 7, 2023

PR types

PR changes

Description

中文文档添加任务

新增中文文档：

英文文档链接：

paddle-bot bot commented Dec 7, 2023

paddle-bot bot commented Dec 7, 2023

Vvsmile 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

Vvsmile Jan 17, 2024 • edited Loading

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

Vvsmile commented Jan 17, 2024

sunzhongkai588 left a comment

Choose a reason for hiding this comment

zade23 commented Jan 17, 2024

sunzhongkai588 left a comment

Choose a reason for hiding this comment

Vvsmile Jan 17, 2024 •

edited

Loading