未验证 提交 24b30441 编写于 作者: L liym27 提交者: GitHub

add docments about control flow (#1714)

* add .rst file of 4 control flow APIs

* add Note in docs of control flow. test=develop
上级 ff287ab1
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_layers_case:
case
----
.. autofunction:: paddle.fluid.layers.case
:noindex:
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_layers_cond:
cond
----
.. autofunction:: paddle.fluid.layers.cond
:noindex:
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_layers_switch_case:
switch_case
-----------
.. autofunction:: paddle.fluid.layers.switch_case
:noindex:
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_layers_while_loop:
while_loop
----------
.. autofunction:: paddle.fluid.layers.while_loop
:noindex:
......@@ -9,6 +9,10 @@ IfElse
cond是一个shape为[N, 1]、数据类型为bool的2-D tensor,表示输入数据对应部分的执行条件。
.. note::
如果参数 ``cond`` 的形状为[1],强烈建议您使用新的OP :ref:`cn_api_fluid_layers_cond` 而不是 ``IfElse``。
OP :ref:`cn_api_fluid_layers_cond` 的使用方式更简单,并且调用该OP所用的代码更少且功能与 ``IfElse`` 一样。
IfElse OP同其他的OP在使用上有一定的区别,可能会对一些用户造成一定的困惑,以下展示了一个
简单的样例对该OP进行说明。
......
......@@ -7,6 +7,10 @@ Switch
该类用于实现Switch分支控制功能。Switch分支包含多个case分支和一个default分支,Switch控制流会依次检查各case分支条件是否满足,并仅执行第一个满足条件的case分支后面的语句。若不存在满足条件的case分支,则仅执行default分支后面的语句。
.. note::
如果参数 ``cond`` 的形状为[1],强烈建议您使用新的OP :ref:`cn_api_fluid_layers_case` 而不是 ``Switch``。
OP :ref:`cn_api_fluid_layers_case` 的使用方式更简单,并且调用该OP所用的代码更少且功能与 ``Switch`` 一样。
成员函数:
- **case(cond)** - Switch的case分支,其参数cond为bool型的标量Variable。只有当前case分支的cond为True,且之前的case分支的cond均为False,该case分支后的语句才会执行,且不再执行之后的case后的语句。
- **default()** - Switch的default分支。当所有case分支的cond均为False时,执行default分支后的语句。
......
......@@ -8,6 +8,9 @@ While
该类用于实现while循环控制功能,只要循环条件cond为True,就循环执行while循环体中的语句,直到cond为False为止。
.. note::
如果参数 ``cond`` 的形状为[1],强烈建议您使用新的OP :ref:`cn_api_fluid_layers_while_loop` 而不是 ``While``。
OP :ref:`cn_api_fluid_layers_while_loop` 的使用方式更简单,并且调用该OP所用的代码更少且功能与 ``While`` 一样。
参数:
- **cond** (Variable) – 用于判断循环继续进行的条件,为数据类型bool型的Tensor,其shape必须为[1]。
......
......@@ -13,6 +13,7 @@ IfElse
请参考 :ref:`cn_api_fluid_layers_IfElse`
**注意:** 强烈建议您使用新的OP :ref:`cn_api_fluid_layers_cond` 而不是 ``IfElse``。:ref:`cn_api_fluid_layers_cond` 的使用方式更简单,并且调用该OP所用的代码更少且功能与 ``IfElse`` 一样。
Switch
======
......@@ -25,6 +26,8 @@ Switch
请参考 :ref:`cn_api_fluid_layers_Switch`
**注意:** 强烈建议您使用新的OP :ref:`cn_api_fluid_layers_case` 而不是 ``Switch``。 :ref:`cn_api_fluid_layers_case` 的使用方式更简单,并且调用该OP所用的代码更少且功能与 ``Switch`` 一样。
While
=====
......@@ -36,6 +39,8 @@ While 循环,当条件判断为真时,循环执行 :code:`While` 控制流
请参考 :ref:`cn_api_fluid_layers_While`
**注意:** 强烈建议您使用新的OP :ref:`cn_api_fluid_layers_while_loop` 而不是 ``While``。 :ref:`cn_api_fluid_layers_while_loop` 的使用方式更简单,并且调用该OP所用的代码更少且功能与 ``While`` 一样。
DynamicRNN
==========
......
......@@ -13,6 +13,7 @@ Conditional branch, for the input of a batch, according to the given conditions,
Please refer to :ref:`api_fluid_layers_IfElse`
**Note:** A new OP :ref:`api_fluid_layers_cond` is highly recommended instead of ``IfElse`` . OP :ref:`api_fluid_layers_cond` is easier to use and is called with less code but does the same thing as ``IfElse`` .
Switch
======
......@@ -25,6 +26,8 @@ Switch, like the :code:`switch-case` declaration commonly found in programming l
Please refer to :ref:`api_fluid_layers_Switch`
**Note:** A new OP :ref:`api_fluid_layers_case` is highly recommended instead of ``Switch`` . OP :ref:`api_fluid_layers_case` is easier to use and is called with less code but does the same thing as ``Switch`` .
While
=====
......@@ -36,6 +39,9 @@ When the condition is true, repeatedly execute logic in the :code:`block` which
Please refer to :ref:`api_fluid_layers_While`
**Note**: A new OP :ref:`api_fluid_layers_while_loop` is highly recommended instead of ``While`` . OP :ref:`api_fluid_layers_while_loop` is easier to use and is called with less code but does the same thing as ``While`` .
DynamicRNN
==========
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册