From 963de16bfd7deba24af70f0183fd3295d480c863 Mon Sep 17 00:00:00 2001 From: Helin Wang Date: Wed, 22 Feb 2017 15:42:55 -0800 Subject: [PATCH] change from google python style to pep 287 --- python/paddle/reader/decorator.py | 55 ++++++++++++++----------------- 1 file changed, 24 insertions(+), 31 deletions(-) diff --git a/python/paddle/reader/decorator.py b/python/paddle/reader/decorator.py index 5fc799e61da..d656d5feb4f 100644 --- a/python/paddle/reader/decorator.py +++ b/python/paddle/reader/decorator.py @@ -21,19 +21,17 @@ import random def shuffle(reader, buf_size): - """Creates a data reader whose data output is suffled. + """ + Creates a data reader whose data output is suffled. Output from the iterator that created by original reader will be buffered into shuffle buffer, and then shuffled. The size of shuffle buffer is determined by argument buf_size. - Args: - reader: the original reader whose output will be - shuffled. - buf_size: shuffle buffer size. + :param reader: the original reader whose output will be shuffled. + :param buf_size: shuffle buffer size. - Returns: - the new reader whose output is shuffled. + :returns:the new reader whose output is shuffled. """ def data_reader(): @@ -55,8 +53,9 @@ def shuffle(reader, buf_size): def chain(*readers): - """Creates a data reader whose output is the outputs of input data - readers chained together. + """ + Creates a data reader whose output is the outputs of input data + readers chained together. If input readers output following data entries: [0, 0, 0] @@ -65,11 +64,8 @@ def chain(*readers): The chained reader will output: [0, 0, 0, 1, 1, 1, 2, 2, 2] - Args: - readers: input readers. - - Returns: - the new data reader. + :param readers: input readers. + :returns: the new data reader. """ def reader(): @@ -88,25 +84,23 @@ class ComposeNotAligned(ValueError): def compose(*readers, **kwargs): - """Creates a data reader whose output is the combination of input readers. + """ + Creates a data reader whose output is the combination of input readers. If input readers output following data entries: (1, 2) 3 (4, 5) The composed reader will output: (1, 2, 3, 4, 5) - Args: - *readers: readers that will be composed together. - check_alignment: If True, will check if input readers are aligned - correctly. If False, will not check alignment and trailing outputs - will be discarded. Defaults to True. + :*readers: readers that will be composed together. + :check_alignment: if True, will check if input readers are aligned + correctly. If False, will not check alignment and trailing outputs + will be discarded. Defaults to True. - Returns: - the new data reader. + :returns: the new data reader. - Raises: - ComposeNotAligned: outputs of readers are not aligned. - Will not raise when check_alignment is set to False. + :raises ComposeNotAligned: outputs of readers are not aligned. + Will not raise when check_alignment is set to False. """ check_alignment = kwargs.pop('check_alignment', True) @@ -136,18 +130,17 @@ def compose(*readers, **kwargs): def buffered(reader, size): - """Creates a buffered data reader. + """ + Creates a buffered data reader. The buffered data reader will read and save data entries into a buffer. Reading from the buffered data reader will proceed as long as the buffer is not empty. - Args: - reader: the data reader to read from. - size: max buffer size. + :param reader: the data reader to read from. + :param size: max buffer size. - Returns: - The buffered data reader. + :returns: the buffered data reader. """ class EndSignal(): -- GitLab