tools/accuracy_checker/accuracy_checker/launcher/dlsdk_launcher_readme.md

   1 # How to configure OpenVINO™ launcher
   2
   3 For enabling OpenVINO™ launcher you need to add `framework: dlsdk` in launchers section of your configuration file and provide following parameters:
   4
   5 * `device` - specifies which device will be used for infer. Supported: `CPU`, `GPU`, `FPGA`, `MYRIAD` and Heterogeneous plugin as `HETERO:target_device,fallback_device`.
   6 * `model` - path to xml file with Caffe model for your topology.
   7 * `weights` - path to bin file with weights for your topology.
   8
   9 launcher may optionally provide model parameters in source framework format which will be converted to Inference Engine IR using Model Optimizer.
  10 If you want to use Model Optimizer for model conversion, please view [Model Optimizer Developer Guide][openvino-mo].
  11 You can provide:
  12
  13 * `caffe_model` and `caffe_weights` for Caffe model and weights (*.prototxt and *.caffemodel).
  14 * `tf_model` for TensorFlow model (*.pb, *.pb.frozen, *.pbtxt).
  15 * `mxnet_weights` for MXNet params (*.params).
  16 * `onnx_model` for ONNX model (*.onnx).
  17 * `kaldi_model` for Kaldi model (*.nnet).
  18
  19 In case when you want to determine additional parameters for model conversion (data_type, input_shape and so on), you can use `mo_params` for arguments with values and `mo_flags` for positional arguments like `legacy_mxnet_model` .
  20 Full list of supported parameters you can find in Model Optimizer Developer Guide.
  21
  22 Model will be converted before every evaluation.
  23 You can provide `converted_model_dir` for saving converted model in specific folder, otherwise, converted models will be saved in path provided via `-C` command line argument or source model directory.
  24
  25 * `adapter` - approach how raw output will be converted to representation of dataset problem, some adapters can be specific to framework. You can find detailed instruction how to use adapters [here][adapters].
  26
  27 Launcher understands which batch size will be used from model intermediate representation (IR). If you want to use batch for infer, please, provide model with required batch or convert it using specific parameter in `mo_params`.
  28
  29 * `allow_reshape_input` - parameter, which allows to reshape input layer to data shape (default value is False).
  30
  31 Additionally you can provide device specific parameters:
  32
  33 * `cpu_extensions` (path to extension *.so file with custom layers for cpu).
  34 * `gpu_extensions` (path to extension *.xml file with OpenCL kernel description for gpu).
  35 * `bitstream` for running on FPGA.
  36
  37 OpenVINO™ launcher config example:
  38
  39 ```yml
  40 launchers:
  41   - framework: dlsdk
  42     device: HETERO:FPGA,CPU
  43     caffe_model: path_to_model/alexnet.prototxt
  44     caffe_weights: path_to_weights/alexnet.caffemodel
  45     adapter: classification
  46     mo_params:
  47       batch: 4
  48     mo_flags:
  49       - reverse_input_channels
  50     cpu_extensions: cpu_extentions_avx512.so
  51 ```
  52
  53 [adapters]: ./tools/accuracy_checker/accuracy_checker/adapters/README.md
  54 [openvino-mo]: https://software.intel.com/en-us/articles/OpenVINO-ModelOptimizer