提交 964361bf 编写于 作者: H huzhiqiang 提交者: juncaipeng

(2) modify io.compose inference doc (#1308)

* modify io.compose inference doc
上级 585d3ce8
.. _cn_api_fluid_io_compose:
composs
compose
-------------------------------
.. py:function:: paddle.fluid.io.compose(*readers, **kwargs)
创建一个数据读取器,输出为输入数据读取器组合到一起的结果,如果输入如下:
该接口将多个数据读取器组合为一个数据读取器,返回读取器的输出包含所有输入读取器的输出。
(1,2) 3 (4,5)
例如:如果输入为三个reader,三个reader的输出分别为:(1,2)、3、(4,5),则组合reader的输出为:(1,2,3,4,5)。
输出将会为(1,2,3,4,5)。
参数:
- **readers** - 将被组合的多个数据读取器(Reader),数据读取器的定义参见 :ref:`cn_api_paddle_data_reader_reader` 。
- **check_alignment** (bool) - 可选,指明是否对输入reader进行对齐检查,默认值为True。如果为True,将检查输入reader是否正确对齐。如果为False,将不检查对齐并自动丢弃无法对齐的末尾数据。
参数:
- **readers** – 要组合的输入reader
- **check_alignment** (bool) - 若为True,将会检查输入readers是否正确的对准,若为False,将不会检查是否对准并且不会跟踪输出,默认为True。
返回:数据读取器(Reader)。
返回:新的数据reader。
**代码示例**:
Raises:ComposeNotAligned - 输出readers没有对齐,当check_alignment设置为False时将不会raise。
\ No newline at end of file
.. code-block:: python
import paddle.fluid as fluid
def reader_creator_10(dur):
def reader():
for i in range(10):
yield i
return reader
reader = fluid.io.compose(reader_creator_10(0), reader_creator_10(0))
注意: 运行过程可能会抛出异常 ``ComposeNotAligned`` ,原因是输入的readers数据未对齐。 当check_alignment设置为False时,不会检查并触发该异常。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册