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

【PaddlePaddle Hackathon 2】16、doc for rrelu #4725

Merged
merged 7 commits into from May 31, 2022

Conversation

thunder95
Copy link
Contributor

增加nn.RReLU和nn.functional.rrelu的中文文档。

该算子的实现PR为PaddlePaddle/Paddle#41823

PADDLEPADDLE_PR=41823

@paddle-bot-old
Copy link

paddle-bot-old bot commented May 5, 2022

Thanks for your contribution!

参数
::::::::::
- lower (float, 可选) - 负值斜率的随机值范围下限,`lower`包含在范围中。支持的数据类型:float。默认值为0.125。
- upper (float, 可选) - 负值斜率的随机值范围上限,`upper`包含在范围中。支持的数据类型:float。默认值为0.333。
Copy link
Collaborator

Choose a reason for hiding this comment

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

  • lower upper 需要空格,否则markdown无法正确解析
  • 注意中英文标点符号不要混用: , -->

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

完成

ax & \text{ otherwise }
\end{cases}

其中,:math:`x` 为输入的 Tensor
Copy link
Collaborator

Choose a reason for hiding this comment

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

句尾标点符号

Copy link
Contributor Author

Choose a reason for hiding this comment

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

完成

::::::::::
- lower (float, 可选) - 负值斜率的随机值范围下限,`lower`包含在范围中。支持的数据类型:float。默认值为0.125。
- upper (float, 可选) - 负值斜率的随机值范围上限,`upper`包含在范围中。支持的数据类型:float。默认值为0.333。
- training (bool): 标记是否为训练阶段。 默认: True。
Copy link
Collaborator

Choose a reason for hiding this comment

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

: --> -
, -->

Copy link
Contributor Author

Choose a reason for hiding this comment

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

完成

\end{cases}

其中,:math:`x` 为输入的 Tensor。

Copy link
Collaborator

Choose a reason for hiding this comment

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

中英文需要保持一致,英文部分有附参考论文

Copy link
Contributor Author

Choose a reason for hiding this comment

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

完成

其中,:math:`x` 为输入的 Tensor。

参数
::::::::::
Copy link
Collaborator

Choose a reason for hiding this comment

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

参数缺少x的介绍?源码中是有5个参数的,可以参考:https://github.com/PaddlePaddle/docs/blob/develop/docs/templates/common_docs.py#L40

Copy link
Contributor Author

Choose a reason for hiding this comment

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

完成

::::::::::
- lower (float,可选) - 负值斜率的随机值范围下限,`lower` 包含在范围中。支持的数据类型:float。默认值为0.125。
- upper (float,可选) - 负值斜率的随机值范围上限,`upper` 包含在范围中。支持的数据类型:float。默认值为0.333。
- training (bool) - 标记是否为训练阶段。 默认: True。
Copy link
Collaborator

Choose a reason for hiding this comment

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

training有默认值,所以是可选参数

Copy link
Contributor Author

Choose a reason for hiding this comment

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

完成

- lower (float,可选) - 负值斜率的随机值范围下限,`lower` 包含在范围中。支持的数据类型:float。默认值为0.125。
- upper (float,可选) - 负值斜率的随机值范围上限,`upper` 包含在范围中。支持的数据类型:float。默认值为0.333。
- training (bool) - 标记是否为训练阶段。 默认: True。
- name (str, 可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。
Copy link
Collaborator

Choose a reason for hiding this comment

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

, -->

Copy link
Contributor Author

Choose a reason for hiding this comment

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

完成

形状:
::::::::::
- input: 任意形状的Tensor,默认数据类型为float32。
- output: 和input具有相同形状的Tensor。
Copy link
Collaborator

@Ligoml Ligoml May 10, 2022

Choose a reason for hiding this comment

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

  • 形状后面不需要加
  • --> -

Copy link
Contributor Author

Choose a reason for hiding this comment

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

完成

::::::::::
- lower (float,可选) - 负值斜率的随机值范围下限,`lower` 包含在范围中。支持的数据类型:float。默认值为0.125。
- upper (float,可选) - 负值斜率的随机值范围上限,`upper` 包含在范围中。支持的数据类型:float。默认值为0.333。
- name (str, 可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。
Copy link
Collaborator

Choose a reason for hiding this comment

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

, -->

Copy link
Contributor Author

Choose a reason for hiding this comment

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

完成


参数
::::::::::
- lower (float,可选) - 负值斜率的随机值范围下限,`lower` 包含在范围中。支持的数据类型:float。默认值为0.125。
Copy link
Collaborator

Choose a reason for hiding this comment

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

参数需要加粗,参考:

  • lower (float,可选) - 负值斜率的随机值范围下限,lower 包含在范围中。支持的数据类型:float。默认值为0.125。

@Ligoml
Copy link
Collaborator

Ligoml commented May 13, 2022

CI没过,辛苦再检查一下
image

Copy link
Collaborator

@Ligoml Ligoml left a comment

Choose a reason for hiding this comment

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

LGTM

@Ligoml Ligoml merged commit 9d270bd into PaddlePaddle:develop May 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants