未验证 提交 4c8c5b4b 编写于 作者: H Huihuang Zheng 提交者: GitHub

Modify English Doc of ControlFlow APIs for Scalar Tensor (#49890)

Modify English Doc of ControlFlow APIs for Scalar Tensor

Corresponding Chinese Doc PR: https://github.com/PaddlePaddle/docs/pull/5588
上级 5ffc22da
...@@ -569,7 +569,7 @@ def case(pred_fn_pairs, default=None, name=None): ...@@ -569,7 +569,7 @@ def case(pred_fn_pairs, default=None, name=None):
This operator works like an if-elif-elif-else chain. This operator works like an if-elif-elif-else chain.
Args: Args:
pred_fn_pairs(list|tuple): A list or tuple of (pred, fn) pairs. ``pred`` is a boolean Tensor with shape [1], ``fn`` is a callable. All callables return the same structure of Tensors. pred_fn_pairs(list|tuple): A list or tuple of (pred, fn) pairs. ``pred`` is a boolean Tensor whose numel should be 1 (shape [] or shape [1]), ``fn`` is a callable. All callables return the same structure of Tensors.
default(callable, optional): Callable that returns a structure of Tensors. default(callable, optional): Callable that returns a structure of Tensors.
name(str, optional): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`. name(str, optional): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`.
...@@ -702,7 +702,7 @@ def switch_case(branch_index, branch_fns, default=None, name=None): ...@@ -702,7 +702,7 @@ def switch_case(branch_index, branch_fns, default=None, name=None):
This operator is like a C++ switch/case statement. This operator is like a C++ switch/case statement.
Args: Args:
branch_index(Tensor): A Tensor with shape [1] to specify which branch to execute. The data type is ``int32``, ``int64`` or ``uint8``. branch_index(Tensor): A Tensor whose numel should be 1 (shape [] or shape [1]) to specify which branch to execute. The data type is ``int32``, ``int64`` or ``uint8``.
branch_fns(dict|list|tuple): If it's a list or tuple, the elements in it could be pairs of (int, callable) or simple callables whose actual index will be used as the index of callable. If it's a dict, its key is a python integer and the value is a callable. All callables return the same structure of Tensors. branch_fns(dict|list|tuple): If it's a list or tuple, the elements in it could be pairs of (int, callable) or simple callables whose actual index will be used as the index of callable. If it's a dict, its key is a python integer and the value is a callable. All callables return the same structure of Tensors.
default(callable, optional): Callable that returns a structure of Tensors. default(callable, optional): Callable that returns a structure of Tensors.
name(str, optional): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`. name(str, optional): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`.
...@@ -910,9 +910,9 @@ def cond(pred, true_fn=None, false_fn=None, name=None, return_names=None): ...@@ -910,9 +910,9 @@ def cond(pred, true_fn=None, false_fn=None, name=None, return_names=None):
branch will be executed during runtime. branch will be executed during runtime.
Args: Args:
pred(Tensor): A boolean tensor whose numel should be 1. The boolean pred(Tensor): A boolean tensor whose numel should be 1 (shape []
value determines whether to return the result of ``true_fn`` or or shape [1]). The boolean value determines whether to return the
``false_fn`` . result of ``true_fn`` or ``false_fn`` .
true_fn(callable, optional): A callable to be performed if ``pred`` is true_fn(callable, optional): A callable to be performed if ``pred`` is
true. The default value is ``None`` . true. The default value is ``None`` .
false_fn(callable, optional): A callable to be performed if ``pred`` is false_fn(callable, optional): A callable to be performed if ``pred`` is
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册