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
Changes from 3 commits
4e3ed9e
8b4ca06
d1dc2ce
00619db
56b5b15
3300f7d
7ef29f6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
.. _cn_api_nn_RReLU: | ||
|
||
RReLU | ||
------------------------------- | ||
.. py:class:: paddle.nn.RReLU(lower=1./8., upper=1./3., name=None) | ||
|
||
RReLU激活层(RReLU Activation Operator)。计算公式如下: | ||
|
||
如果使用近似计算: | ||
|
||
.. math:: | ||
|
||
\text{RReLU}(x) = | ||
\begin{cases} | ||
x & \text{if } x \geq 0 \\ | ||
ax & \text{ otherwise } | ||
\end{cases} | ||
|
||
其中,:math:`x` 为输入的 Tensor。 | ||
|
||
参数 | ||
:::::::::: | ||
- lower (float,可选) - 负值斜率的随机值范围下限,`lower` 包含在范围中。支持的数据类型:float。默认值为0.125。 | ||
- upper (float,可选) - 负值斜率的随机值范围上限,`upper` 包含在范围中。支持的数据类型:float。默认值为0.333。 | ||
- name (str, 可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 完成 |
||
|
||
形状: | ||
:::::::::: | ||
- input: 任意形状的Tensor,默认数据类型为float32。 | ||
- output: 和input具有相同形状的Tensor。 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 完成 |
||
|
||
代码示例 | ||
::::::::: | ||
COPY-FROM: paddle.nn.RRelu:RRelu-example |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
.. _cn_api_nn_cn_prelu: | ||
|
||
rrelu | ||
------------------------------- | ||
|
||
.. py:function:: paddle.nn.functional.rrelu(x, lower=1. / 8., upper=1. / 3., training=True, name=None) | ||
|
||
rrelu激活层(RRelu Activation Operator)。计算公式如下: | ||
|
||
.. math:: | ||
|
||
\text{RReLU}(x) = | ||
\begin{cases} | ||
x & \text{if } x \geq 0 \\ | ||
ax & \text{ otherwise } | ||
\end{cases} | ||
|
||
其中,:math:`x` 为输入的 Tensor。 | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 中英文需要保持一致,英文部分有附参考论文 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 完成 |
||
参数 | ||
:::::::::: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 There was a problem hiding this comment. Choose a reason for hiding this commentThe 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。 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. training有默认值,所以是可选参数 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 完成 |
||
- name (str, 可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 完成 |
||
|
||
返回 | ||
:::::::::: | ||
``Tensor`` ,数据类型和形状同 ``x`` 一致。 | ||
|
||
代码示例 | ||
::::::::: | ||
COPY-FROM: paddle.nn.functional.rrelu:rrelu-example |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
参数需要加粗,参考:
lower
包含在范围中。支持的数据类型:float。默认值为0.125。