inference-engine/tools/calibration_tool/README.md

   1 # Python* Calibration Tool
   2
   3 The Python* Calibration Tool calibrates a given FP32 model so that you can run calibrated model in low-precision 8-bit integer mode while keeping the input data of this model in the original precision.
   4 The Calibration Tool is a Python\* command-line tool, which imports Python types from the `openvino.tools.calibration` package.
   5
   6 > **NOTE**: INT8 models are currently supported only by the CPU plugin. For the full list of supported configurations, see the [Supported Devices](./docs/IE_DG/supported_plugins/Supported_Devices.md) topic.
   7
   8 ## Hardware requirements
   9 Hardware requirements depend on a model. Typically for public models RAM memory size has to be not less then 16Gb, drive has to have not less then 30 GB free space independently on operation system. Temporary directory is used to cache layers output during calibration.
  10
  11 ## Usage
  12 The Calibration Tool is configured in the same way as the Accuracy Checker. You can also use additional command-line arguments to define calibration-specific parameters.
  13
  14 ### Command-Line Arguments for the Accuracy Checker Tool reused in Calibration Tool
  15 | Argument                                     | Type   | Description                                             |
  16 | -------------------------------------------- | ------ | ------------------------------------------------------- |
  17 | -c, --config                                 | string | Optional. Path to the YML file with local configuration |
  18 | -d, --definitions                            | string | Optional. Path to the YML file with definitions         |
  19 | -m, --models                                 | string | Optional. Prefix path to the models and weights. In the simplified mode, it is the path to IR .xml file   |
  20 | -s, --source                                 | string | Optional. Prefix path to the data source. In the simplified mode, it is the path to a folder with images   |
  21 | -a, --annotations                            | string | Optional. Prefix path to the converted annotations and datasets meta data |
  22 | -e, --extensions                             | string | Optional. Prefix path to extensions folder. In simplified mode is a path to extensions library |
  23 | --cpu_extensions_mode, --cpu-extensions-mode | string | Optional. specified preferable set of processor instruction for automatic searching the CPU extension lib: `avx2` or `sse4` |
  24 | -C, --converted_models, --converted-models   | string | Optional. Directory to store Model Optimizer converted models. Used for DLSDK launcher only |
  25 | -M, --model_optimizer, --model-optimizer     | string | Optional. Path to model optimizer Caffe* directory       |
  26 | --tf_custom_op_config_dir, --tf-custom-op-config-dir | string | Optional. Path to directory with TensorFlow* custom operation configuration files for model optimizer |
  27 | --tf_obj_detection_api_pipeline_config_path, --tf-obj-detection-api-pipeline-config-path | string | Optional. Path to directory with TensorFlow object detection API pipeline configuration files for the Model Optimizer |
  28 | --progress                                   | string | Optional. Progress reporter: `bar`, `print` or `None`   |
  29 | -td, --target_devices, --target-devices      | string | Optional. Space-separated list of devices for infer     |
  30 | -tt, --target_tags, --target-tags | string   | Optional. Space-separated list of launcher tags for infer        |
  31
  32 ### Specific Command Line Arguments for Calibration Tool
  33 | Argument                          | Type   | Description                                               |
  34 | --------------------------------- | ------ | --------------------------------------------------------- |
  35 | -p, --precision                   | string | Optional. Precision to calibrate. Default value is INT8. In the simplified mode, determines output IR precision   |
  36 | --ignore_layer_types, --ignore-layer-types | string | Optional. Layer types list which will be skipped during quantization |
  37 | --ignore_layer_types_path, --ignore-layer-types-path | string | Optional. Ignore layer types file path |
  38 | --ignore_layer_names, --ignore-layer-names | string | Optional. Layer names list which will be skipped during quantization |
  39 | --ignore_layer_names_path, --ignore-layer-names-path | string | Optional. Ignore layer names file path |
  40 | --batch_size, --batch-size        | integer| Optional. Batch size value. If not specified, the batch size value is determined from IR |
  41 | -th, --threshold                  | float | Optional. Accuracy drop of quantized model should not exceed this threshold. Should be pointer in percents without percent sign. (1% is default) |
  42 | -ic, --benchmark_iterations_count, --benchmark-iterations-count | integer | Optional. Benchmark iterations count (1 is default). |
  43 | -mn, --metric_name, --metric-name | string | Optional. Metric name used during calibration |
  44 | -mt, --metric_type, --metric-type | string | Optional. Metric type used during calibration |
  45 | -o, --output_dir, --output-dir    | string | Optional. Directory to store converted models. Original model directory is used if not defined |
  46
  47 ### Simplified mode
  48 | Argument                          | Type   | Description                                               |
  49 | --------------------------------- | ------ | --------------------------------------------------------- |
  50 | -sm, --simplified_mode, --simplified-mode |   | Optional. If specified, the Calibration Tool collects statistics without searching for optimal data thresholds. |
  51 | -ss, --subset                     | integer | Optional. This option is used only with --simplified_mode. Specifies a number of images from a folder that is set using `-s` option. |
  52
  53 ## Model Calibration Flow
  54
  55 ### Introduction
  56 The calibration tool read original FP32 model, calibration dataset and create low precision model. Low precision model has two differences from original model:
  57 1. Per channel statistics are defined. Statistics have minimum and maximum values for each layer and each channel. Model statistics are stored in Inference Engine intermediate representation file (IR) in XML format.
  58 2. `quantization_level` layer attribute is defined. The attribute defines precision which is used during inference.
  59
  60 ### Prerequisites
  61 * Model: Tensorflow\* Inception v1. You can download the model from here: https://github.com/tensorflow/models/tree/master/research/slim
  62 * Dataset: ImageNet. You can download ImageNet from here: http://www.image-net.org/download.php
  63 * YML configuration files: you can find YML configuration files and YML definition file which are used below in `configs` directory:
  64   - `definitions.yml` - definition file
  65   - `inception_v1.yml` - configuration file for Tensorflow\* Inception v1 model
  66   - `ncf_config.yml` - configuration file for NCF model in OpenVINO\* Inference Engine Intermediate Representation format
  67   - `ssd_mobilenet_v1_coco.yml` - configuration file for Tensorflow\* SSD Mobilenet v1 model
  68   - `unet2d.yml` - configuration file for Unet2D mode in in OpenVINO\* Inference Engine Intermediate Representation format
  69
  70 If you have custom topology with not supported accuracy metric or not suported custom dataset then you should add some components implementation in `openvino.tools.accuracy_checker` Python\* package yourself. Refer to `openvino.tools.accuracy_checker` documentation how to implement metric and dataset support.
  71
  72 There are steps to calibrate and evaluate result model:
  73 - Step #1. Convert data annotation files
  74 - Optional step for low precision model performance estimation.
  75 - Step #2. Calibration
  76 - Step #3. Result model evaluation
  77
  78 Additional optional step before calibration is available to rough estimate possible INT8 performance.
  79
  80 ### Step #1. Convert Data Annotation Files
  81 Calibration dataset is subset of training dataset. Use Convert Annotation Tool to convert ImageNet\* dataset to Calibration Tool readable data annotation files. Data annotation files describe subset of images which are used during calibration. Command line:
  82 ```sh
  83 python convert_annotation.py imagenet --annotation_file /datasets/ImageNet/val.txt --labels_file /datasets/ImageNet/synset_words.txt -ss 2000 -o ~/annotations -a imagenet.pickle -m imagenet.json
  84 ```
  85
  86 > **NOTE:** For simplicity all command line tools in below steps use the same command line arguments. In practice [Collect Statistics Tool](./inference-engine/tools/collect_statistics_tool/README.md) uses calibration dataset, but [Accuracy Checker Tool](./inference-engine/tools/accuracy_checker_tool/README.md) has to use whole validation dataset.
  87
  88
  89 | Argument           | Type   | Description                                                                       |
  90 | -------------------| ------ | --------------------------------------------------------------------------------- |
  91 | --config           | string | Path to the YML file with local configuration                                     |
  92 | -d                 | string | Path to the YML file with definitions                                             |
  93 | -M                 | string | Path to model optimizer directory                                                 |
  94 | --models           | string | Prefix path to the models and weights                                             |
  95 | --source           | string | Prefix path to the data source                                                    |
  96 | --annotations      | string | Pefix path to the converted annotations and datasets meta data                    |
  97 | --converted_models | string | Directory to store Model Optimizer converted models. Used for DLSDK launcher only |
  98
  99
 100 ### Optional Step for Low Precision Model Performance Estimation
 101
 102 Before calibration, you can roughly estimate low precision performance with [Collect Statistics Tool](./inference-engine/tools/collect_statistics_tool/README.md).
 103
 104 [Collect Statistics Tool](./inference-engine/tools/collect_statistics_tool/README.md) ignores metric in YML configuration file but you can use the same command line arguments.
 105
 106 Command line:
 107
 108 ```sh
 109 python collect_statistics.py --config ~/inception_v1.yml -d ~/defenitions.yml -M /home/user/intel/openvino/deployment_tools/model_optimizer --models ~/models --source /media/user/calibration/datasets --annotations ~/annotations --converted_models ~/models
 110 ```
 111
 112 Result model has statistics which allow you to infer this model in INT8 precision. To measure performance you can use [Benchmark Tool](./inference-engine/tools/benchmark_tool/README.md).
 113
 114 ### Step #2. Calibration
 115 During calibration process, the model is ajusted for efficient quantization and minimization of accuracy drop on calibration dataset. Calibration tool produces calibrated model which will be executed in low precision 8 bit quantzed mode after loading into CPU plugin.
 116
 117 [Calibration Tool](./inference-engine/tools/calibration_tool/README.md) has flexible and extensible mechanism of enabling new data set and metrics. Each network has its own dedicated network metric and dataset where network was trained. Dataset description and network metrics can be reused for different network.
 118
 119 To plug new dataset you need to develop YML file. To develop new metric you need to develop Python\* module implementing metric and describe in YML. Please, refer to [Accuracy Checker Tool](./inference-engine/tools/accuracy_checker_tool/README.md) for details.
 120
 121
 122 Command line example:
 123 ```sh
 124 python calibrate.py --config ~/inception_v1.yml --definition ~/defenitions.yml -M /home/user/intel/openvino/deployment_tools/model_optimizer --tf_custom_op_config_dir ~/tf_custom_op_configs --models ~/models --source /media/user/calibration/datasets --annotations ~/annotations
 125 ```
 126
 127 ### Step #3. Result model evaluation
 128 After calibration of the model it worse to evaluate network accuracy on whole validation set using [Accuracy Checker Tool](./inference-engine/tools/accuracy_checker_tool/README.md).
 129
 130 #### Step #3.1 Check accuracy
 131 Command line:
 132 ```sh
 133 python accuracy_check.py --config ~/inception_v1.yml -d ~/defenitions.yml -M /home/user/intel/openvino/deployment_tools/model_optimizer --tf_custom_op_config_dir ~/tf_custom_op_configs --models ~/models --source /media/user/calibration/datasets --annotations ~/annotations -tf dlsdk -td CPU
 134 ```
 135
 136 #### Step #3.2 Check performance
 137 Use `benchmark_app` command line tool to measure latency and throughput for synchronous and asynchronous modes. Note, please, `benchmark_app` command line tool uses converted OpenVINO\* Intermediate Representation model.
 138
 139 Command line for synchronous mode:
 140
 141 ```sh
 142 ./benchmark_app -i <path_to_image>/inputImage.bmp -m <path_to_model>/inception_v1.xml -d CPU -api sync
 143 ```
 144
 145 Command line for the asynchronous mode:
 146 ```sh
 147 ./benchmark_app -i <path_to_image>/inputImage.bmp -m <path_to_model>/inception_v1.xml -d CPU -api async
 148 ```
 149
 150 #### Optional step to check performance
 151 You can use Python\* [Benchmark Tool](./inference-engine/tools/benchmark_tool/README.md) command line tool to quickly check performance with the same command line arguments and configuration YML files as for [Calibration Tool](./inference-engine/tools/calibration_tool/README.md).
 152
 153 Command line:
 154 ```sh
 155 python benchmark.py --config ~/inception_v1.yml -d ~/defenitions.yml -M /home/user/intel/openvino/deployment_tools/model_optimizer --tf_custom_op_config_dir ~/tf_custom_op_configs --models ~/models --source /media/user/calibration/datasets --annotations ~/annotations --converted_models ~/models
 156 ```
 157
 158 ## Simplified Mode Flow
 159
 160 The Calibration Tool in the simplified mode helps to quickly estimate performance of a model. It converts all possible layers into INT8 and collects statistics without achieving needed accuracy. The tool generates new IR, which is used in performance tests. Therefore, the tool in this mode does not use Accuracy Checker, configuration and annotation files, but you should specify paths to an IR .xml file and a dataset folder. Optionally, you can specify a path to an extensions library and the number of images from the dataset folder. In simplified mode path to an extensions is a path to extensions library.
 161
 162 To run the Calibration Tool in the simplified mode, use the following command:
 163 ```sh
 164 python3 calibrate.py -sm -m <path-to-ir.xml> -s <path-to-dataset> -ss img_num -e <path-to-extensions-library> -td target_device
 165 ```
 166 It accepts models with FP32, FP16 precisions and images as dataset.
 167