During the training and testing phases, PaddlePaddle programs need to read data. To help the users write code that performs reading input data, we define the following:

• A reader: A function that reads data (from file, network, random number generator, etc) and yields the data items.
• A reader decorator: A function, which takes in one or more readers, and returns a reader.
• A batch reader: A function that reads data (from reader, file, network, random number generator, etc) and yields a batch of data items.

Data reader doesn't have to be a function that reads and yields data items. It can just be any function without any parameters that creates an iterable (anything can be used in for x in iterable) as follows:

iterable = data_reader()


The item produced from the iterable should be a single entry of data and not a mini batch. The entry of data could be a single item or a tuple of items. Item should be of one of the supported types (e.g., numpy 1d array of float32, int, list of int etc.)

An example implementation for single item data reader creator is as follows:

def reader_creator_random_image(width, height):
while True:
yield numpy.random.uniform(-1, 1, size=width*height)


An example implementation for multiple item data reader creator is as follows:

def reader_creator_random_image_and_label(width, height, label):
while True:
yield numpy.random.uniform(-1, 1, size=width*height), label


Batch reader can be any function without any parameters that creates an iterable (anything can be used in for x in iterable). The output of the iterable should be a batch (list) of data items. Each item inside the list should be a tuple.

Here are some valid outputs:

# a mini batch of three data items. Each data item consist three columns of data, each of which is 1.
[(1, 1, 1),
(2, 2, 2),
(3, 3, 3)]

# a mini batch of three data items, each data item is a list (single column).
[([1,1,1],),
([2,2,2],),
([3,3,3],)]


Please note that each item inside the list must be a tuple, below is an invalid output:

 # wrong, [1,1,1] needs to be inside a tuple: ([1,1,1],).
# Otherwise it is ambiguous whether [1,1,1] means a single column of data [1, 1, 1],
# or three columns of data, each of which is 1.
[[1,1,1],
[2,2,2],
[3,3,3]]


It is easy to convert from a reader to a batch reader:

mnist_train = paddle.dataset.mnist.train()


It is also straight forward to create a custom batch reader:

def custom_batch_reader():
while True:
batch = []
for i in xrange(128):
batch.append((numpy.random.uniform(-1, 1, 28*28),)) # note that it's a tuple being appended.
yield batch



## Usage

Following is how we can use the reader with PaddlePaddle: The batch reader, a mapping from item(s) to data layer, the batch size and the number of total passes will be passed into paddle.train as follows:

# two data layer is created:

# ...


The Data reader decorator takes in a single reader or multiple data readers and returns a new data reader. It is similar to a python decorator, but it does not use @ in the syntax.

Since we have a strict interface for data readers (no parameters and return a single data item), a data reader can be used in a flexible way using data reader decorators. Following are a few examples:

### Prefetch Data

Since reading data may take some time and training can not proceed without data, it is generally a good idea to prefetch the data.

Use paddle.reader.buffered to prefetch data:

buffered_reader = paddle.reader.buffered(paddle.dataset.mnist.train(), 100)


buffered_reader will try to buffer (prefetch) 100 data entries.

For example, if we want to use a source of real images (say reusing mnist dataset), and a source of random images as input for Generative Adversarial Networks.

We can do the following :

def reader_creator_random_image(width, height):
while True:
yield numpy.random.uniform(-1, 1, size=width*height)

while True:
yield t

# Skipped 1 because paddle.dataset.mnist.train() produces two items per data entry.
# And we don't care about the second item at this time.


### Shuffle

Given the shuffle buffer size n, paddle.reader.shuffle returns a data reader that buffers n data entries and shuffles them before a data entry is read.

Example:

reader = paddle.reader.shuffle(paddle.dataset.mnist.train(), 512)


## Q & A

### Why does a reader return only a single entry, and not a mini batch?

Returning a single entry makes reusing existing data readers much easier (for example, if an existing reader returns 3 entries instead of a single entry, the training code will be more complicated because it needs to handle cases like a batch size 2).

We provide a function: paddle.batch to turn (a single entry) reader into a batch reader.

### Why do we need a batch reader, isn't is sufficient to give the reader and batch_size as arguments during training ?

In most of the cases, it would be sufficient to give the reader and batch_size as arguments to the train method. However sometimes the user wants to customize the order of data entries inside a mini batch, or even change the batch size dynamically. For these cases using a batch reader is very efficient and helpful.

### Why use a dictionary instead of a list to provide mapping?

Using a dictionary ({"image":0, "label":1}) instead of a list (["image", "label"]) gives the advantage that the user can easily reuse the items (e.g., using {"image_a":0, "image_b":0, "label":1}) or even skip an item (e.g., using {"image_a":0, "label":2}).

### How to create a custom data reader creator ?

def image_reader_creator(image_path, label_path, n):
f = open(image_path)
l = open(label_path)
images = numpy.fromfile(
f, 'ubyte', count=n * 28 * 28).reshape((n, 28 * 28)).astype('float32')
images = images / 255.0 * 2.0 - 1.0
labels = numpy.fromfile(l, 'ubyte', count=n).astype("int")
for i in xrange(n):
yield images[i, :], labels[i] # a single entry of data is created each time
f.close()
l.close()


### How is paddle.train implemented
def train(batch_reader, mapping, batch_size, total_pass):