未验证 提交 de3bb584 编写于 作者: L liu zhengxi 提交者: GitHub

improve the doc of double_buffer (#1246)

* update the cn_doc of double_buffer

* add more information for double_buffer api

* add optional for parameters have default value

* add more infomation for Variable Reader

* correct the expression
上级 0646b6c8
...@@ -6,15 +6,18 @@ double_buffer ...@@ -6,15 +6,18 @@ double_buffer
.. py:function:: paddle.fluid.layers.double_buffer(reader, place=None, name=None) .. py:function:: paddle.fluid.layers.double_buffer(reader, place=None, name=None)
生成一个双缓冲队列reader. 数据将复制到具有双缓冲队列的位置(由place指定),如果 ``place=none`` 则将使用executor执行的位置。 生成一个双缓冲队列Reader。Reader类有DecoratedReader和FileReader,其中DecoratedReader又可以细分成CustomReader和BufferedReader。这里是基于BufferedReader,数据将复制到具有双缓冲队列的位置(由place指定),如果 ``place=None`` 则将使用executor执行的位置。
参数: 参数:
- **reader** (Variable) – 需要wrap的reader - **reader** (Variable) – 需要wrap的reader变量Reader。
- **place** (Place) – 目标数据的位置. 默认是executor执行样本的位置. - **place** (Place,可选) – 目标数据的位置,比如CPU,GPU,GPU需要指明是哪张卡。默认是executor执行样本的位置。
- **name** (str) – Variable 的名字. 默认为None,不关心名称时也可以设置为None - **name** (str,可选) – 变量的名字。该参数供开发人员打印调试信息时使用,具体用法参见 :ref:`api_guide_Name`,默认值为None。
返回: 双缓冲队列的reader
返回:Variable(Reader)。双缓冲队列的reader。
返回类型:变量(Variable)。
**代码示例** **代码示例**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册