{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<!--- Licensed to the Apache Software Foundation (ASF) under one -->\n",
    "<!--- or more contributor license agreements.  See the NOTICE file -->\n",
    "<!--- distributed with this work for additional information -->\n",
    "<!--- regarding copyright ownership.  The ASF licenses this file -->\n",
    "<!--- to you under the Apache License, Version 2.0 (the -->\n",
    "<!--- \"License\"); you may not use this file except in compliance -->\n",
    "<!--- with the License.  You may obtain a copy of the License at -->\n",
    "\n",
    "<!---   http://www.apache.org/licenses/LICENSE-2.0 -->\n",
    "\n",
    "<!--- Unless required by applicable law or agreed to in writing, -->\n",
    "<!--- software distributed under the License is distributed on an -->\n",
    "<!--- \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->\n",
    "<!--- KIND, either express or implied.  See the License for the -->\n",
    "<!--- specific language governing permissions and limitations -->\n",
    "<!--- under the License. -->\n",
    "\n",
    "# Quantize with MKL-DNN backend\n",
    "\n",
    "This document is to introduce how to quantize the customer models from FP32 to INT8 with Apache/MXNet toolkit and APIs under Intel CPU.\n",
    "\n",
    "If you are not familiar with Apache/MXNet quantization flow, please reference [quantization blog](https://medium.com/apache-mxnet/model-quantization-for-production-level-neural-network-inference-f54462ebba05) first, and the performance data is shown in [Apache/MXNet C++ interface](https://github.com/apache/incubator-mxnet/tree/master/cpp-package/example/inference) and [GluonCV](https://gluon-cv.mxnet.io/build/examples_deployment/int8_inference.html). \n",
    "\n",
    "## Installation and Prerequisites\n",
    "\n",
    "Installing MXNet with MKLDNN backend is an easy and essential process. You can follow [How to build and install MXNet with MKL-DNN backend](/api/python/docs/tutorials/performance/backend/mkldnn/mkldnn_readme.html) to build and install MXNet from source. Also, you can install the release or nightly version via PyPi and pip directly by running:"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "```\n",
    "# release version\n",
    "pip install mxnet-mkl\n",
    "# nightly version\n",
    "pip install mxnet-mkl --pre\n",
    "```\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Image Classification Demo\n",
    "\n",
    "A quantization script [imagenet_gen_qsym_mkldnn.py](https://github.com/apache/incubator-mxnet/blob/master/example/quantization/imagenet_gen_qsym_mkldnn.py) has been designed to launch quantization for image-classification models. This script is  integrated with [Gluon-CV modelzoo](https://gluon-cv.mxnet.io/model_zoo/classification.html), so that all pre-trained models can be downloaded from Gluon-CV and then converted for quantization. For details, you can refer [Model Quantization with Calibration Examples](https://github.com/apache/incubator-mxnet/blob/master/example/quantization/README.md).\n",
    "\n",
    "## Integrate Quantization Flow to Your Project\n",
    "\n",
    "Quantization flow works for both symbolic and Gluon models. If you're using Gluon, you can first refer [Saving and Loading Gluon Models](/api/python/docs/tutorials/packages/gluon/blocks/save_load_params.html) to hybridize your computation graph and export it as a symbol before running quantization.\n",
    "\n",
    "In general, the quantization flow includes 4 steps. The user can get the acceptable accuracy from step 1 to 3 with minimum effort. Most of thing in this stage is out-of-box and the data scientists and researchers only need to focus on how to represent data and layers in their model. After a quantized model is generated, you may want to deploy it online and the performance will be the next key point. Thus, step 4, calibration, can improve the performance a lot by reducing lots of runtime calculation.\n",
    "\n",
    "![quantization flow](https://github.com/dmlc/web-data/raw/master/mxnet/tutorials/mkldnn/quantization/quantization.png)\n",
    "\n",
    "Now, we are going to take Gluon ResNet18 as an example to show how each step work.\n",
    "\n",
    "### Initialize Model"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "```python\n",
    "import logging\n",
    "import mxnet as mx\n",
    "from mxnet.gluon.model_zoo import vision\n",
    "from mxnet.contrib.quantization import *\n",
    "\n",
    "logging.basicConfig()\n",
    "logger = logging.getLogger('logger')\n",
    "logger.setLevel(logging.INFO)\n",
    "\n",
    "batch_shape = (1, 3, 224, 224)\n",
    "resnet18 = vision.resnet18_v1(pretrained=True)\n",
    "resnet18.hybridize()\n",
    "resnet18.forward(mx.nd.zeros(batch_shape))\n",
    "resnet18.export('resnet18_v1')\n",
    "sym, arg_params, aux_params = mx.model.load_checkpoint('resnet18_v1', 0)\n",
    "# (optional) visualize float32 model\n",
    "mx.viz.plot_network(sym)\n",
    "```\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "First, we download resnet18-v1 model from gluon modelzoo and export it as a symbol. You can visualize float32 model. Below is a raw residual block.\n",
    "\n",
    "![float32 model](https://github.com/dmlc/web-data/raw/master/mxnet/tutorials/mkldnn/quantization/fp32_raw.png)\n",
    "\n",
    "#### Model Fusion"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "```python\n",
    "sym = sym.get_backend_symbol('MKLDNN_QUANTIZE')\n",
    "# (optional) visualize fused float32 model\n",
    "mx.viz.plot_network(sym)\n",
    "```\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "It's important to add this line to enable graph fusion before quantization to get better performance. Below is a fused residual block. Batchnorm, Activation and elemwise_add are fused into Convolution.\n",
    "\n",
    "![float32 fused model](https://github.com/dmlc/web-data/raw/master/mxnet/tutorials/mkldnn/quantization/fp32_fusion.png)\n",
    "\n",
    "### Quantize Model\n",
    "\n",
    "A python interface `quantize_graph` is provided for the user. Thus, it is very flexible for the data scientist to construct the expected models based on different requirements in a real deployment."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "```python\n",
    "# quantize configs\n",
    "# set exclude layers\n",
    "excluded_names = []\n",
    "# set calib mode.\n",
    "calib_mode = 'none'\n",
    "# set calib_layer\n",
    "calib_layer = None\n",
    "# set quantized_dtype\n",
    "quantized_dtype = 'auto'\n",
    "logger.info('Quantizing FP32 model Resnet18-V1')\n",
    "qsym, qarg_params, aux_params, collector = quantize_graph(sym=sym, arg_params=arg_params, aux_params=aux_params,\n",
    "                                                          excluded_sym_names=excluded_names,\n",
    "                                                          calib_mode=calib_mode, calib_layer=calib_layer,\n",
    "                                                          quantized_dtype=quantized_dtype, logger=logger)\n",
    "# (optional) visualize quantized model\n",
    "mx.viz.plot_network(qsym)\n",
    "# save quantized model\n",
    "mx.model.save_checkpoint('quantized-resnet18_v1', 0, qsym, qarg_params, aux_params)\n",
    "```\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "By applying `quantize_graph` to the symbolic model, a new quantized model can be generated, named `qsym` along with its parameters. We can see `_contrib_requantize` operators are inserted after `Convolution` to convert the INT32 output to FP32. \n",
    "\n",
    "![none calibrated model](https://github.com/dmlc/web-data/raw/master/mxnet/tutorials/mkldnn/quantization/none_calib.png)\n",
    "\n",
    "Below table gives some descriptions.\n",
    "\n",
    "| param              | type            | description|\n",
    "|--------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n",
    "| excluded_sym_names | list of strings | A list of strings representing the names of the symbols that users want to excluding from being quantized.|\n",
    "| calib_mode         | str             | If calib_mode='none', no calibration will be used and the thresholds for requantization after the corresponding layers will be calculated at runtime by calling min  and max operators. The quantized models generated in this mode are normally 10-20% slower than those with  calibrations during inference.<br>If calib_mode='naive', the min and max values of the layer outputs from a calibration dataset will be directly taken as the thresholds for quantization.<br>If calib_mode='entropy', the thresholds for quantization will be derived such that the KL divergence between the distributions of FP32 layer outputs and  quantized layer outputs is minimized based upon the calibration dataset. |\n",
    "| calib_layer        | function        | Given a layer's output name in string, return True or False for deciding whether to calibrate this layer.<br>If yes, the statistics of the layer's output will be collected; otherwise, no information of the layer's output will be collected.<br>If not provided, all the layers' outputs that need requantization will be collected.|\n",
    "| quantized_dtype    | str             | The quantized destination type for input data. Currently support 'int8', 'uint8' and 'auto'.<br>'auto' means automatically select output type according to calibration result.|\n",
    "\n",
    "### Evaluate & Tune\n",
    "\n",
    "Now, you get a pair of quantized symbol and params file for inference. For Gluon inference, only difference is to load model and params by a SymbolBlock as below example:"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "```python\n",
    "quantized_net = mx.gluon.SymbolBlock.imports('quantized-resnet18_v1-symbol.json', 'data', 'quantized-resnet18_v1-0000.params')\n",
    "quantized_net.hybridize(static_shape=True, static_alloc=True)\n",
    "batch_size = 1\n",
    "data = mx.nd.ones((batch_size,3,224,224))\n",
    "quantized_net(data)\n",
    "```\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Now, you can get the accuracy from a quantized network. Furthermore, you can try to select different layers or OPs to be quantized by `excluded_sym_names` parameter and figure out an acceptable accuracy.\n",
    "\n",
    "### Calibrate Model (optional for performance)\n",
    "\n",
    "The quantized model generated in previous steps can be very slow during inference since it will calculate min and max at runtime. We recommend using offline calibration for better performance by setting `calib_mode` to `naive` or `entropy`. And then calling `set_monitor_callback` api to collect layer information with a subset of the validation datasets before int8 inference."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "```python\n",
    "# quantization configs\n",
    "# set exclude layers\n",
    "excluded_names = []\n",
    "# set calib mode.\n",
    "calib_mode = 'naive'\n",
    "# set calib_layer\n",
    "calib_layer = None\n",
    "# set quantized_dtype\n",
    "quantized_dtype = 'auto'\n",
    "logger.info('Quantizing FP32 model resnet18-V1')\n",
    "cqsym, cqarg_params, aux_params, collector = quantize_graph(sym=sym, arg_params=arg_params, aux_params=aux_params,\n",
    "                                                          excluded_sym_names=excluded_names,\n",
    "                                                          calib_mode=calib_mode, calib_layer=calib_layer,\n",
    "                                                          quantized_dtype=quantized_dtype, logger=logger)\n",
    "\n",
    "# download imagenet validation dataset\n",
    "mx.test_utils.download('https://data.mxnet.io/data/val_256_q90.rec', 'dataset.rec')\n",
    "# set rgb info for data\n",
    "mean_std = {'mean_r': 123.68, 'mean_g': 116.779, 'mean_b': 103.939, 'std_r': 58.393, 'std_g': 57.12, 'std_b': 57.375}\n",
    "# set batch size\n",
    "batch_size = 16\n",
    "# create DataIter\n",
    "data = mx.io.ImageRecordIter(path_imgrec='dataset.rec', batch_size=batch_size, data_shape=batch_shape[1:], rand_crop=False, rand_mirror=False, **mean_std)\n",
    "# create module\n",
    "mod = mx.mod.Module(symbol=sym, label_names=None, context=mx.cpu())\n",
    "mod.bind(for_training=False, data_shapes=data.provide_data, label_shapes=None)\n",
    "mod.set_params(arg_params, aux_params)\n",
    "\n",
    "# calibration configs\n",
    "# set num_calib_batches\n",
    "num_calib_batches = 5\n",
    "max_num_examples = num_calib_batches * batch_size\n",
    "# monitor FP32 Inference\n",
    "mod._exec_group.execs[0].set_monitor_callback(collector.collect, monitor_all=True)\n",
    "num_batches = 0\n",
    "num_examples = 0\n",
    "for batch in data:\n",
    "    mod.forward(data_batch=batch, is_train=False)\n",
    "    num_batches += 1\n",
    "    num_examples += batch_size\n",
    "    if num_examples >= max_num_examples:\n",
    "        break\n",
    "if logger is not None:\n",
    "    logger.info(\"Collected statistics from %d batches with batch_size=%d\"\n",
    "                % (num_batches, batch_size))\n",
    "```\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "After that, layer information will be filled into the `collector` returned by `quantize_graph` api. Then, you need to write the layer information into int8 model by calling `calib_graph` api."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "```python\n",
    "# write scaling factor into quantized symbol\n",
    "cqsym, cqarg_params, aux_params = calib_graph(qsym=cqsym, arg_params=arg_params, aux_params=aux_params,\n",
    "                                            collector=collector, calib_mode=calib_mode,\n",
    "                                            quantized_dtype=quantized_dtype, logger=logger)\n",
    "# (optional) visualize quantized model\n",
    "mx.viz.plot_network(cqsym)\n",
    "```\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Below is a quantized residual block with naive calibration. We can see `min_calib_range` and `max_calib_range` are written into `_contrib_requantize` operators.\n",
    "\n",
    "![naive calibrated model](https://github.com/dmlc/web-data/raw/master/mxnet/tutorials/mkldnn/quantization/naive_calib.png)\n",
    "\n",
    "When you get a quantized model with calibration, keeping sure to call fusion api again since this can fuse some `requantize` or `dequantize` operators for further performance improvement."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "```python\n",
    "# perform post-quantization fusion\n",
    "cqsym = cqsym.get_backend_symbol('MKLDNN_QUANTIZE')\n",
    "# (optional) visualize post-quantized model\n",
    "mx.viz.plot_network(cqsym)\n",
    "# save quantized model\n",
    "mx.model.save_checkpoint('quantized-resnet18_v1', 0, cqsym, cqarg_params, aux_params)\n",
    "```\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Below is a post-quantized residual block. We can see `_contrib_requantize` operators are fused into `Convolution` operators.\n",
    "\n",
    "![post-quantized model](https://github.com/dmlc/web-data/raw/master/mxnet/tutorials/mkldnn/quantization/post_quantize.png)\n",
    "\n",
    "BTW, You can also modify the `min_calib_range` and `max_calib_range` in the JSON file directly."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "```\n",
    "    {\n",
    "      \"op\": \"_sg_mkldnn_conv\", \n",
    "      \"name\": \"quantized_sg_mkldnn_conv_bn_act_6\", \n",
    "      \"attrs\": {\n",
    "        \"max_calib_range\": \"3.562147\", \n",
    "        \"min_calib_range\": \"0.000000\", \n",
    "        \"quantized\": \"true\", \n",
    "        \"with_act\": \"true\", \n",
    "        \"with_bn\": \"true\"\n",
    "      }, \n",
    "......\n",
    "```\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Tips for Model Calibration\n",
    "\n",
    "#### Accuracy Tuning\n",
    "\n",
    "- Try to use `entropy` calib mode;\n",
    "\n",
    "- Try to exclude some layers which may cause obvious accuracy drop;\n",
    "\n",
    "- Change calibration dataset by setting different `num_calib_batches` or shuffle your validation dataset;\n",
    "\n",
    "#### Performance Tuning\n",
    "\n",
    "- Keep sure to perform graph fusion before quantization;\n",
    "\n",
    "- If lots of `requantize` layers exist, keep sure to perform post-quantization fusion after calibration;\n",
    "\n",
    "- Compare the MXNet profile or `MKLDNN_VERBOSE` of float32 and int8 inference;\n",
    "\n",
    "## Deploy with Python/C++\n",
    "\n",
    "MXNet also supports deploy quantized models with C++. Refer [MXNet C++ Package](https://github.com/apache/incubator-mxnet/blob/master/cpp-package/README.md) for more details.\n",
    "\n",
    "<!-- INSERT SOURCE DOWNLOAD BUTTONS -->"
   ]
  }
 ],
 "metadata": {
  "language_info": {
   "name": "python"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}