{"nbformat": 4, "cells": [{"source": "# Handwritten Digit Recognition\n\nIn this tutorial, we'll give you a step by step walk-through of how to build a hand-written digit classifier using the [MNIST](https://en.wikipedia.org/wiki/MNIST_database) dataset. For someone new to deep learning, this exercise is arguably the \"Hello World\" equivalent.\n\nMNIST is a widely used dataset for the hand-written digit classification task. It consists of 70,000 labeled 28x28 pixel grayscale images of hand-written digits. The dataset is split into 60,000 training images and 10,000 test images. There are 10 classes (one for each of the 10 digits). The task at hand is to train a model using the 60,000 training images and subsequently test its classification accuracy on the 10,000 test images.\n\n![png](https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/example/mnist.png)\n\n**Figure 1:** Sample images from the MNIST dataset.\n\n## Prerequisites\nTo complete this tutorial, we need: \n\n- MXNet version 0.10 or later. See the installation instructions for your operating system in [Setup and Installation](http://mxnet.io/install/index.html).\n\n- [Python Requests](http://docs.python-requests.org/en/master/) and [Jupyter Notebook](http://jupyter.org/index.html).\n\n```\n$ pip install requests jupyter\n```\n\n## Loading Data\n\nBefore we define the model, let's first fetch the [MNIST](http://yann.lecun.com/exdb/mnist/) dataset.\n\nThe following source code downloads and loads the images and the corresponding labels into memory.", "cell_type": "markdown", "metadata": {}}, {"source": "import mxnet as mx\nmnist = mx.test_utils.get_mnist()\n\n# Fix the seed\nmx.random.seed(42)\n\n# Set the compute context, GPU is available otherwise CPU\nctx = mx.gpu() if mx.test_utils.list_gpus() else mx.cpu()", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "After running the above source code, the entire MNIST dataset should be fully loaded into memory. Note that for large datasets it is not feasible to pre-load the entire dataset first like we did here. What is needed is a mechanism by which we can quickly and efficiently stream data directly from the source. MXNet Data iterators come to the rescue here by providing exactly that. Data iterator is the mechanism by which we feed input data into an MXNet training algorithm and they are very simple to initialize and use and are optimized for speed. During training, we typically process training samples in small batches and over the entire training lifetime will end up processing each training example multiple times. In this tutorial, we'll configure the data iterator to feed examples in batches of 100. Keep in mind that each example is a 28x28 grayscale image and the corresponding label.\n\nImage batches are commonly represented by a 4-D array with shape `(batch_size, num_channels, width, height)`. For the MNIST dataset, since the images are grayscale, there is only one color channel. Also, the images are 28x28 pixels, and so each image has width and height equal to 28. Therefore, the shape of input is `(batch_size, 1, 28, 28)`. Another important consideration is the order of input samples. When feeding training examples, it is critical that we don't feed samples with the same label in succession. Doing so can slow down training.\nData iterators take care of this by randomly shuffling the inputs. Note that we only need to shuffle the training data. The order does not matter for test data.\n\nThe following source code initializes the data iterators for the MNIST dataset. Note that we initialize two iterators: one for train data and one for test data.", "cell_type": "markdown", "metadata": {}}, {"source": "batch_size = 100\ntrain_iter = mx.io.NDArrayIter(mnist['train_data'], mnist['train_label'], batch_size, shuffle=True)\nval_iter = mx.io.NDArrayIter(mnist['test_data'], mnist['test_label'], batch_size)", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "## Training\nWe will cover a couple of approaches for performing the hand written digit recognition task. The first approach makes use of a traditional deep neural network architecture called Multilayer Perceptron (MLP). We'll discuss its drawbacks and use that as a motivation to introduce a second more advanced approach called Convolution Neural Network (CNN) that has proven to work very well for image classification tasks.\n\n### Multilayer Perceptron\n\nThe first approach makes use of a [Multilayer Perceptron](https://en.wikipedia.org/wiki/Multilayer_perceptron) to solve this problem. We'll define the MLP using MXNet's symbolic interface. We begin by creating a place holder variable for the input data. When working with an MLP, we need to flatten our 28x28 images into a flat 1-D structure of 784 (28 * 28) raw pixel values. The order of pixel values in the flattened vector does not matter as long as we are being consistent about how we do this across all images.", "cell_type": "markdown", "metadata": {}}, {"source": "data = mx.sym.var('data')\n# Flatten the data from 4-D shape into 2-D (batch_size, num_channel*width*height)\ndata = mx.sym.flatten(data=data)", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "One might wonder if we are discarding valuable information by flattening. That is indeed true and we'll cover this more when we talk about convolutional neural networks where we preserve the input shape. For now, we'll go ahead and work with flattened images.\n\nMLPs contains several fully connected layers. A fully connected layer or FC layer for short, is one where each neuron in the layer is connected to every neuron in its preceding layer. From a linear algebra perspective, an FC layer applies an [affine transform](https://en.wikipedia.org/wiki/Affine_transformation) to the *n x m* input matrix *X* and outputs a matrix *Y* of size *n x k*, where *k* is the number of neurons in the FC layer. *k* is also referred to as the hidden size. The output *Y* is computed according to the equation *Y = X W^{T} + b*. The FC layer has two learnable parameters, the *k x m* weight matrix *W* and the *1 x k* bias vector *b*. The summation of bias vector follows the broadcasting rules explained in [`mxnet.sym.broadcast_to()`](https://mxnet.incubator.apache.org/api/python/symbol/symbol.html#mxnet.symbol.broadcast_to). Conceptually, broadcasting replicates row elements of the bias vector to create an *n x k* matrix before summation.\n\n\nIn an MLP, the outputs of most FC layers are fed into an activation function, which applies an element-wise non-linearity. This step is critical and it gives neural networks the ability to classify inputs that are not linearly separable. Common choices for activation functions are sigmoid, tanh, and [rectified linear unit](https://en.wikipedia.org/wiki/Rectifier_%28neural_networks%29) (ReLU). In this example, we'll use the ReLU activation function which has several desirable properties and is typically considered a default choice.\n\nThe following code declares two fully connected layers with 128 and 64 neurons each. Furthermore, these FC layers are sandwiched between ReLU activation layers each one responsible for performing an element-wise ReLU transformation on the FC layer output.", "cell_type": "markdown", "metadata": {}}, {"source": "# The first fully-connected layer and the corresponding activation function\nfc1 = mx.sym.FullyConnected(data=data, num_hidden=128)\nact1 = mx.sym.Activation(data=fc1, act_type=\"relu\")\n\n# The second fully-connected layer and the corresponding activation function\nfc2 = mx.sym.FullyConnected(data=act1, num_hidden = 64)\nact2 = mx.sym.Activation(data=fc2, act_type=\"relu\")", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "The last fully connected layer often has its hidden size equal to the number of output classes in the dataset. The activation function for this layer will be the softmax function. The Softmax layer maps its input to a probability score for each class of output. During the training stage, a loss function computes the [cross entropy](https://en.wikipedia.org/wiki/Cross_entropy) between the probability distribution (softmax output) predicted by the network and the true probability distribution given by the label.\n\nThe following source code declares the final fully connected layer of size 10. 10 incidentally is the total number of digits. The output from this layer is fed into a `SoftMaxOutput` layer that performs softmax and cross-entropy loss computation in one go. Note that loss computation only happens during training.", "cell_type": "markdown", "metadata": {}}, {"source": "# MNIST has 10 classes\nfc3 = mx.sym.FullyConnected(data=act2, num_hidden=10)\n# Softmax with cross entropy loss\nmlp = mx.sym.SoftmaxOutput(data=fc3, name='softmax')", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "![png](https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mlp_mnist.png)\n\n**Figure 2:** MLP network architecture for MNIST.\n\nNow that both the data iterator and neural network are defined, we can commence training. Here we'll employ the `module` feature in MXNet which provides a high-level abstraction for running training and inference on predefined networks. The module API allows the user to specify appropriate parameters that control how the training proceeds.\n\nThe following source code initializes a module to train the MLP network we defined above. For our training, we will make use of the stochastic gradient descent (SGD) optimizer. In particular, we'll be using mini-batch SGD. Standard SGD processes train data one example at a time. In practice, this is very slow and one can speed up the process by processing examples in small batches. In this case, our batch size will be 100, which is a reasonable choice. Another parameter we select here is the learning rate, which controls the step size the optimizer takes in search of a solution. We'll pick a learning rate of 0.1, again a reasonable choice. Settings such as batch size and learning rate are what are usually referred to as hyper-parameters. What values we give them can have a great impact on training performance. For the purpose of this tutorial, we'll start with some reasonable and safe values. In other tutorials, we'll discuss how one might go about finding a combination of hyper-parameters for optimal model performance.\n\nTypically, one runs the training until convergence, which means that we have learned a good set of model parameters (weights + biases) from the train data. For the purpose of this tutorial, we'll run training for 10 epochs and stop. An epoch is one full pass over the entire train data.", "cell_type": "markdown", "metadata": {}}, {"source": "import logging\nlogging.getLogger().setLevel(logging.DEBUG) # logging to stdout\n# create a trainable module on compute context\nmlp_model = mx.mod.Module(symbol=mlp, context=ctx)\nmlp_model.fit(train_iter, # train data\n eval_data=val_iter, # validation data\n optimizer='sgd', # use SGD to train\n optimizer_params={'learning_rate':0.1}, # use fixed learning rate\n eval_metric='acc', # report accuracy during training\n batch_end_callback = mx.callback.Speedometer(batch_size, 100), # output progress for each 100 data batches\n num_epoch=10) # train for at most 10 dataset passes", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "### Prediction\n\nAfter the above training completes, we can evaluate the trained model by running predictions on test data. The following source code computes the prediction probability scores for each test image. *prob[i][j]* is the probability that the *i*-th test image contains the *j*-th output class.", "cell_type": "markdown", "metadata": {}}, {"source": "test_iter = mx.io.NDArrayIter(mnist['test_data'], None, batch_size)\nprob = mlp_model.predict(test_iter)\nassert prob.shape == (10000, 10)", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "Since the dataset also has labels for all test images, we can compute the accuracy metric as follows:", "cell_type": "markdown", "metadata": {}}, {"source": "test_iter = mx.io.NDArrayIter(mnist['test_data'], mnist['test_label'], batch_size)\n# predict accuracy of mlp\nacc = mx.metric.Accuracy()\nmlp_model.score(test_iter, acc)\nprint(acc)\nassert acc.get()[1] > 0.96, \"Achieved accuracy (%f) is lower than expected (0.96)\" % acc.get()[1]", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "If everything went well, we should see an accuracy value that is around 0.96, which means that we are able to accurately predict the digit in 96% of test images. This is a pretty good result. But as we will see in the next part of this tutorial, we can do a lot better than that.\n\n### Convolutional Neural Network\n\nEarlier, we briefly touched on a drawback of MLP when we said we need to discard the input image's original shape and flatten it as a vector before we can feed it as input to the MLP's first fully connected layer. Turns out this is an important issue because we don't take advantage of the fact that pixels in the image have natural spatial correlation along the horizontal and vertical axes. A convolutional neural network (CNN) aims to address this problem by using a more structured weight representation. Instead of flattening the image and doing a simple matrix-matrix multiplication, it employs one or more convolutional layers that each performs a 2-D convolution on the input image.\n\nA single convolution layer consists of one or more filters that each play the role of a feature detector. During training, a CNN learns appropriate representations (parameters) for these filters. Similar to MLP, the output from the convolutional layer is transformed by applying a non-linearity. Besides the convolutional layer, another key aspect of a CNN is the pooling layer. A pooling layer serves to make the CNN translation invariant: a digit remains the same even when it is shifted left/right/up/down by a few pixels. A pooling layer reduces a *n x m* patch into a single value to make the network less sensitive to the spatial location. Pooling layer is always included after each conv (+ activation) layer in the CNN.\n\nThe following source code defines a convolutional neural network architecture called LeNet. LeNet is a popular network known to work well on digit classification tasks. We will use a slightly different version from the original LeNet implementation, replacing the sigmoid activations with tanh activations for the neurons", "cell_type": "markdown", "metadata": {}}, {"source": "data = mx.sym.var('data')\n# first conv layer\nconv1 = mx.sym.Convolution(data=data, kernel=(5,5), num_filter=20)\ntanh1 = mx.sym.Activation(data=conv1, act_type=\"tanh\")\npool1 = mx.sym.Pooling(data=tanh1, pool_type=\"max\", kernel=(2,2), stride=(2,2))\n# second conv layer\nconv2 = mx.sym.Convolution(data=pool1, kernel=(5,5), num_filter=50)\ntanh2 = mx.sym.Activation(data=conv2, act_type=\"tanh\")\npool2 = mx.sym.Pooling(data=tanh2, pool_type=\"max\", kernel=(2,2), stride=(2,2))\n# first fullc layer\nflatten = mx.sym.flatten(data=pool2)\nfc1 = mx.symbol.FullyConnected(data=flatten, num_hidden=500)\ntanh3 = mx.sym.Activation(data=fc1, act_type=\"tanh\")\n# second fullc\nfc2 = mx.sym.FullyConnected(data=tanh3, num_hidden=10)\n# softmax loss\nlenet = mx.sym.SoftmaxOutput(data=fc2, name='softmax')", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "![png](https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/conv_mnist.png)\n\n**Figure 3:** First conv + pooling layer in LeNet.\n\nNow we train LeNet with the same hyper-parameters as before. Note that, if a GPU is available, we recommend using it. This greatly speeds up computation given that LeNet is more complex and compute-intensive than the previous multilayer perceptron. To do so, we only need to change `mx.cpu()` to `mx.gpu()` and MXNet takes care of the rest. Just like before, we'll stop training after 10 epochs.", "cell_type": "markdown", "metadata": {}}, {"source": "lenet_model = mx.mod.Module(symbol=lenet, context=ctx)\n# train with the same\nlenet_model.fit(train_iter,\n eval_data=val_iter,\n optimizer='sgd',\n optimizer_params={'learning_rate':0.1},\n eval_metric='acc',\n batch_end_callback = mx.callback.Speedometer(batch_size, 100),\n num_epoch=10)", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "### Prediction\n\nFinally, we'll use the trained LeNet model to generate predictions for the test data.", "cell_type": "markdown", "metadata": {}}, {"source": "test_iter = mx.io.NDArrayIter(mnist['test_data'], None, batch_size)\nprob = lenet_model.predict(test_iter)\ntest_iter = mx.io.NDArrayIter(mnist['test_data'], mnist['test_label'], batch_size)\n# predict accuracy for lenet\nacc = mx.metric.Accuracy()\nlenet_model.score(test_iter, acc)\nprint(acc)\nassert acc.get()[1] > 0.98, \"Achieved accuracy (%f) is lower than expected (0.98)\" % acc.get()[1]", "cell_type": "code", "execution_count": null, "outputs": [], "metadata": {}}, {"source": "If all went well, we should see a higher accuracy metric for predictions made using LeNet. With CNN we should be able to correctly predict around 98% of all test images.\n\n## Summary\n\nIn this tutorial, we have learned how to use MXNet to solve a standard computer vision problem: classifying images of hand written digits. You have seen how to quickly and easily build, train and evaluate models such as MLP and CNN with MXNet.\n\n\n\n\n", "cell_type": "markdown", "metadata": {}}], "metadata": {"display_name": "", "name": "", "language": "python"}, "nbformat_minor": 2}