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

[Docathon][Add CN Doc No.60-61] #6211

Merged
merged 10 commits into from
Sep 28, 2023
Merged

Conversation

zade23
Copy link
Contributor

@zade23 zade23 commented Sep 25, 2023

PR types

Others

PR changes

Docs

Description

中文文档添加任务

#6193

新增中文文档:

  • fused_layer_norm_cn
  • fused_rms_norm_cn

英文文档链接:

序号 API名称 英文文档地址
60 paddle.incubate.nn.functional.fused_layer_norm https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api/paddle/incubate/nn/functional/fused_layer_norm_en.html
61 paddle.incubate.nn.functional.fused_rms_norm https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api/paddle/incubate/nn/functional/fused_rms_norm_en.html

备注

关于 Overview 描述添加:没有添加到 Overview 相关描述中

通过参考相关资料,感觉这两个 API 都是归一化(Normalization)的方式。
目前二者都是处于孵化阶段(incubate)的 API ,不太确定 Overview 这里的正确分类,参考其他paddle/doc中的 fused 同类 API 没有在 Overview 中添加相关描述。

@MARD1NO @sunzhongkai588

@paddle-bot
Copy link

paddle-bot bot commented Sep 25, 2023

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

- **begin_norm_axis** (int) - 归一化的起始轴,默认为 1。
- **bias** (可选|Tensor) - 前一层的偏置,用于融合。
- **residual** (可选|Tensor) - 输入的残差,用于融合。
- **quant_scale** (float) - 量化比例。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

量化缩放因子

- **begin_norm_axis** (int) - 归一化的起始轴,默认为 1。
- **bias** (可选|Tensor) - 前一层的偏置,用于融合。
- **residual** (可选|Tensor) - 输入的残差,用于融合。
- **quant_scale** (float) - 量化比例。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

量化缩放因子

- **residual** (可选|Tensor) - 输入的残差,用于融合。
- **quant_scale** (float) - 量化比例。
- **quant_round_type** (float) - 量化四舍五入类型。
- **quant_max_bound** (float) - 量化的最大边界进行裁剪。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

量化裁剪的最大/最小边界值,下同

- **epsilon** (float) - 一个小的浮点数,用于避免除以零。
- **residual_alpha** (float) - 用于残差的缩放因子,默认为 1。
- **begin_norm_axis** (int) - 归一化的起始轴,默认为 1。
- **bias** (可选|Tensor) - 前一层的偏置,用于融合。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

用于融合,这句可以都删了

@zade23
Copy link
Contributor Author

zade23 commented Sep 27, 2023

@MARD1NO Down

zade23 and others added 5 commits September 28, 2023 11:06
Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>
Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>
Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>
Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>
Copy link
Collaborator

@sunzhongkai588 sunzhongkai588 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@luotao1 luotao1 merged commit 34ad505 into PaddlePaddle:develop Sep 28, 2023
1 check passed
@zade23 zade23 deleted the en_doc_6061 branch September 28, 2023 07:00
@sunzhongkai588 sunzhongkai588 changed the title [Docathon] Add No.60~No.61 API CN Doc [Docathon][Add CN Doc No.60-61] Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor HappyOpenSource 快乐开源活动issue与PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants