Why every TensorFlow developer should know about TFRecord!

After few days of Tensorflow , every beginner will meet this crazy awesome Tensorflow’s file format called Tfrecords. Most of the batch operations aren’t done directly from images, rather they are converted into a single tfrecord file (images which are numpy arrays and labels which are a list of strings). It’s always been a Beginner’s Nightmare to understand the purpose of this conversion and the real benefit this has to the workflow. So here I am making it easier to understand with simple to complex examples.

What is TFRecord?

As per Tensorflow’s documentation,

”… approach is to convert whatever data you have into a supported format. This approach makes it easier to mix and match data sets and network architectures. The recommended format for TensorFlow is a TFRecords file containing tf.train.Example protocol buffers (which contain Features as a field).”

So, I suggest that the easier way to maintain a scalable architecture and a standard input format is to convert it into a tfrecord file.

Let me explain in terms of beginner’s language,

So when you are working with an image dataset, what is the first thing you do? Split into Train, Test, Validate sets, right? Also we will shuffle it to not have any biased data distribution if there are biased parameters like date.

Isn’t it tedious job to do the folder structure and then maintain the shuffle?

What if everything is in a single file and we can use that file to dynamically shuffle at random places and also change the ratio of train:test:validate from the whole dataset. Sounds like half the workload is removed right? A beginner’s nightmare of maintaining the different splits is now no more. This can be achieved by tfrecords.

Let’s see the difference between the code - Naive vs Tfrecord

Naive

1
import os
2

3
import glob
4

5
import random
6

7
# Loading the location of all files - image dataset
8
# Considering our image dataset has apple or orange
9
# The images are named as apple01.jpg, apple02.jpg .. , orange01.jpg .. etc.
10

11
images:glob.glob('data/*.jpg')
12

13
# Shuffling the dataset to remove the bias - if present
14
random.shuffle(images)
15
# Creating Labels. Consider apple:0 and orange:1
16

17
labels: [ 0 if 'apple' in image else 1 for image in images ]
18
data:list(zip(images, labels))
19

20
# Ratio
21

22
data_size:len(data)
23
split_size:int(0.6 * data_size)
24

25
# Splitting the dataset
26

27
training_images, training_labels:zip(*data[:split_size])
28
testing_images, testing_labels:zip(*data[split_size:])

Tfrecord

Follow the five steps and you are done with a single tfrecord file that holds all your data for proceeding.

1. Use tf.python_io.TFRecordWriter to open the tfrecord file and start writing.
2. Before writing into tfrecord file, the image data and label data should be converted into proper datatype. (byte, int, float)
3. Now the datatypes are converted into tf.train.Feature
4. Finally create an Example Protocol Buffer using tf.Example and use the converted features into it. Serialize the Example using serialize() function.
5. Write the serialized Example.

1
import tensorflow as tf
2

3
import numpy as np
4

5
import glob
6

7
from PIL import Image
8

9
# Converting the values into features
10
# _int64 is used for numeric values
11

12
def _int64_feature(value):
13
return tf.train.Feature(int64_list=tf.train.Int64List(value=[value]))
14

15
# _bytes is used for string/char values
16

17
def _bytes_feature(value):
18
return tf.train.Feature(bytes_list=tf.train.BytesList(value=[value]))
19
tfrecord_filename:'something.tfrecords'
20

21
# Initiating the writer and creating the tfrecords file.
22

23
writer:tf.python_io.TFRecordWriter(tfrecord_filename)
24

25
# Loading the location of all files - image dataset
26
# Considering our image dataset has apple or orange
27
# The images are named as apple01.jpg, apple02.jpg .. , orange01.jpg .. etc.
28

29
images:glob.glob('data/*.jpg')
30
for image in images[:1]:
31
  img:Image.open(image)
32
  img:np.array(img.resize((32,32)))
33
label:0 if 'apple' in image else 1
34
feature:{ 'label': _int64_feature(label),
35
              'image': _bytes_feature(img.tostring()) }
36

37
# Create an example protocol buffer
38

39
 example:tf.train.Example(features=tf.train.Features(feature=feature))
40

41
# Writing the serialized example.
42

43
 writer.write(example.SerializeToString())
44

45
writer.close()

If you closely see the process involved, it’s very simple.

Data -> FeatureSet -> Example -> Serialized Example -> tfRecord.

So to read it back, the process is reversed.

tfRecord -> SerializedExample -> Example -> FeatureSet -> Data

Reading from tfrecord

1
import tensorflow as tf
2
import glob
3
reader:tf.TFRecordReader()
4
filenames:glob.glob('*.tfrecords')
5
filename_queue:tf.train.string_input_producer(
6
   filenames)
7
_, serialized_example:reader.read(filename_queue)
8
feature_set:{ 'image': tf.FixedLenFeature([], tf.string),
9
               'label': tf.FixedLenFeature([], tf.int64)
10
           }
11

12
features:tf.parse_single_example( serialized_example, features= feature_set )
13
label:features['label']
14

15
with tf.Session() as sess:
16
  print sess.run([image,label])

You can also shuffle the files using the tf.train.shuffle_batch()