Skip to content

Commit f5ade81

Browse files
zq19xsrobin
authored andcommitted
Synchronize api cn develop 0823 (PaddlePaddle#1126)
* modify fluid.rst and layers.rst and gen_doc.py * synchronize api_cn of develop 0823,test=document_preview * update io_cn.rst * delete ComposeNotAligned_cn.rst
1 parent 2da0e56 commit f5ade81

29 files changed

+1151
-0
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _cn_api_fluid_is_compiled_with_cuda:
2+
3+
is_compiled_with_cuda
4+
-------------------------------
5+
6+
.. py:function:: paddle.fluid.is_compiled_with_cuda()
7+
8+
检查 ``whl`` 包是否可以被用来在GPU上运行模型
9+
10+
返回:支持gpu则为True,否则为False。
11+
12+
返回类型:out(boolean)
13+
14+
**示例代码**
15+
16+
.. code-block:: python
17+
18+
import paddle.fluid as fluid
19+
support_gpu = fluid.is_compiled_with_cuda()
20+
21+

doc/fluid/api_cn/io_cn.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,25 @@ fluid.io
99
.. toctree::
1010
:maxdepth: 1
1111

12+
io_cn/batch_cn.rst
13+
io_cn/buffered_cn.rst
14+
io_cn/cache_cn.rst
15+
io_cn/chain_cn.rst
16+
io_cn/compose_cn.rst
17+
io_cn/Fake_cn.rst
18+
io_cn/firstn_cn.rst
1219
io_cn/load_inference_model_cn.rst
1320
io_cn/load_params_cn.rst
1421
io_cn/load_persistables_cn.rst
1522
io_cn/load_vars_cn.rst
23+
io_cn/map_readers_cn.rst
24+
io_cn/multiprocess_reader_cn.rst
25+
io_cn/PipeReader_cn.rst
1626
io_cn/PyReader_cn.rst
1727
io_cn/save_inference_model_cn.rst
1828
io_cn/save_params_cn.rst
1929
io_cn/save_persistables_cn.rst
2030
io_cn/save_vars_cn.rst
31+
io_cn/shuffle_cn.rst
32+
io_cn/xmap_readers_cn.rst
2133

doc/fluid/api_cn/io_cn/Fake_cn.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _cn_api_fluid_io_Fake:
2+
3+
Fake
4+
-------------------------------
5+
6+
.. py:class:: paddle.fluid.io.Fake
7+
8+
Fakereader将缓存它读取的第一个数据,并将其输出data_num次。它用于缓存来自真实reader的数据,并将其用于速度测试。
9+
10+
参数:
11+
- **reader** – 原始读取器。
12+
- **data_num** – reader产生数据的次数 。
13+
14+
返回: 一个Fake读取器
15+
16+
17+
**代码示例**
18+
19+
.. code-block:: python
20+
21+
def reader():
22+
for i in range(10):
23+
yield i
24+
25+
fake_reader = Fake()(reader, 100)
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _cn_api_fluid_io_PipeReader:
2+
3+
PipeReader
4+
-------------------------------
5+
6+
.. py:class:: paddle.fluid.io.PipeReader
7+
8+
9+
PipeReader从命令中通过流来读取数据,把数据存在一个pipe缓存中,并重定向到解析器中解析,返回预先设计格式的数据。
10+
11+
你可以使用标准的Linux命令或者调用其他程序来读取数据,从HDFS, Ceph, URL, AWS S3等等。
12+
13+
.. code-block:: python
14+
cmd = "hadoop fs -cat /path/to/some/file"
15+
cmd = "cat sample_file.tar.gz"
16+
cmd = "curl http://someurl"
17+
cmd = "python print_s3_bucket.py"
18+
19+
20+
**代码示例**
21+
22+
.. code-block:: python
23+
def example_reader():
24+
for f in myfiles:
25+
pr = PipeReader("cat %s"%f)
26+
for l in pr.get_line():
27+
sample = l.split(" ")
28+
yield sample
29+
30+
.. py:method:: get_line(cut_lines=True,line_break='\n')
31+
32+
参数:
33+
- **cut_lines** (bool) - 给行分割缓存
34+
- **line_break** (string) - 行分隔符,比如'\n'或者'\r'
35+
36+
返回: 行或者字节缓存

doc/fluid/api_cn/io_cn/batch_cn.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _cn_api_fluid_io_batch:
2+
3+
batch
4+
-------------------------------
5+
6+
.. py:function:: paddle.fluid.io.batch(reader, batch_size, drop_last=False)
7+
8+
该层是一个batched reader。
9+
10+
参数:
11+
- **reader** (Variable)-读取数据的数据reader
12+
- **batch_size** (int)-批尺寸
13+
- **drop_last** (bool) - 如果最后一个batch不等于batch_size,则drop最后一个batch。
14+
15+
返回:batched reader
16+
17+
返回类型:callable
18+
19+
20+
21+
22+
23+
24+
25+
26+
27+
28+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _cn_api_fluid_io_buffered:
2+
3+
buffered
4+
-------------------------------
5+
6+
.. py:function:: paddle.fluid.io.buffered(reader, size)
7+
8+
创建一个缓存数据读取器,它读取数据并且存储进缓存区,从缓存区读取数据将会加速,只要缓存不是空的。
9+
10+
参数:
11+
- **reader** (callable) – 读取数据的reader
12+
- **size** (int) – 最大buffer的大小
13+
14+
返回:缓存的reader(读取器)

doc/fluid/api_cn/io_cn/cache_cn.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _cn_api_fluid_io_cache:
2+
3+
cache
4+
-------------------------------
5+
6+
.. py:function:: paddle.fluid.io.cache(reader)
7+
8+
缓存reader数据到内存中,小心此方法可能会花长时间来处理数据,并且会占用大量内存。 ``reader()`` 只能被调用一次。
9+
10+
参数:
11+
- **reader** (callable) – 读取数据的reader,每次都会yields数据。
12+
13+
返回:每次都会从内存中yields数据的一个装饰reader。
14+
15+
返回类型:生成器

doc/fluid/api_cn/io_cn/chain_cn.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _cn_api_fluid_io_chain:
2+
3+
chain
4+
-------------------------------
5+
6+
.. py:function:: paddle.fluid.io.chain(*readers)
7+
8+
创建一个数据读取器,输出为输入数据读取器链接到一起的结果,如果输入如下:
9+
10+
[0, 0, 0]
11+
12+
[1, 1, 1]
13+
14+
[2, 2, 2]
15+
16+
输出将会为[0, 0, 0, 1, 1, 1, 2, 2, 2].
17+
18+
参数:
19+
- **readers** – 输入reader
20+
21+
返回:新的数据reader。
22+
23+
返回类型:callable

doc/fluid/api_cn/io_cn/compose_cn.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. _cn_api_fluid_io_compose:
2+
3+
composs
4+
-------------------------------
5+
6+
.. py:function:: paddle.fluid.io.compose(*readers, **kwargs)
7+
8+
创建一个数据读取器,输出为输入数据读取器组合到一起的结果,如果输入如下:
9+
10+
(1,2) 3 (4,5)
11+
12+
输出将会为(1,2,3,4,5)。
13+
14+
参数:
15+
- **readers** – 要组合的输入reader
16+
- **check_alignment** (bool) - 若为True,将会检查输入readers是否正确的对准,若为False,将不会检查是否对准并且不会跟踪输出,默认为True。
17+
18+
返回:新的数据reader。
19+
20+
Raises:ComposeNotAligned - 输出readers没有对齐,当check_alignment设置为False时将不会raise。

doc/fluid/api_cn/io_cn/firstn_cn.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _cn_api_fluid_io_firstn:
2+
3+
firstn
4+
-------------------------------
5+
6+
.. py:function:: paddle.fluid.io.firstn(reader, n)
7+
8+
限制reader可以返回的最大样本数。
9+
10+
参数:
11+
- **reader** (callable) – 要读取的数据读取器。
12+
- **n** (int) – 返回的最大样本数 。
13+
14+
返回: 装饰reader
15+
16+
返回类型: callable

0 commit comments

Comments
 (0)