inference-engine/samples/object_detection_sample_ssd/README.md

   1 # Object Detection C++ Sample SSD
   2
   3 This topic demonstrates how to run the Object Detection sample application, which does inference using object detection
   4 networks like SSD-VGG on Intel® Processors and Intel® HD Graphics.
   5
   6 ## How It Works
   7
   8 Upon the start-up the sample application reads command line parameters and loads a network and an image to the Inference
   9 Engine plugin. When inference is done, the application creates an
  10 output image and outputs data to the standard output stream.
  11
  12 > **NOTE**: By default, Inference Engine samples and demos expect input with BGR channels order. If you trained your model to work with RGB order, you need to manually rearrange the default channels order in the sample or demo application or reconvert your model using the Model Optimizer tool with `--reverse_input_channels` argument specified. For more information about the argument, refer to **When to Specify Input Shapes** section of [Converting a Model Using General Conversion Parameters](./docs/MO_DG/prepare_model/convert_model/Converting_Model_General.md).
  13
  14 ## Running
  15
  16 Running the application with the <code>-h</code> option yields the following usage message:
  17 ```sh
  18 ./object_detection_sample_ssd -h
  19 InferenceEngine:
  20     API version ............ <version>
  21     Build .................. <number>
  22
  23 object_detection_sample_ssd [OPTION]
  24 Options:
  25
  26     -h                      Print a usage message.
  27     -i "<path>"             Required. Path to an .bmp image.
  28     -m "<path>"             Required. Path to an .xml file with a trained model.
  29       -l "<absolute_path>"    Required for CPU custom layers. Absolute path to a shared library with the kernel implementations.
  30           Or
  31       -c "<absolute_path>"    Required for GPU custom kernels. Absolute path to the .xml file with the kernel descriptions.
  32     -pp "<path>"            Optional. Path to a plugin folder.
  33     -d "<device>"           Optional. Specify the target device to infer on; CPU, GPU, FPGA, HDDL or MYRIAD is acceptable. Sample will look for a suitable plugin for device specified
  34     -pc                     Optional. Enables per-layer performance report
  35     -ni "<integer>"         Optional. Number of iterations. Default value is 1
  36     -p_msg                  Optional. Enables messages from a plugin
  37
  38 ```
  39
  40 Running the application with the empty list of options yields the usage message given above and an error message.
  41
  42 To run the sample, you can use public or pre-trained models. To download the pre-trained models, use the OpenVINO [Model Downloader](https://github.com/opencv/open_model_zoo/tree/2018/model_downloader) or go to [https://download.01.org/opencv/](https://download.01.org/opencv/).
  43
  44 > **NOTE**: Before running the sample with a trained model, make sure the model is converted to the Inference Engine format (\*.xml + \*.bin) using the [Model Optimizer tool](./docs/MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md).
  45
  46 For example, to do inference on a CPU with the OpenVINO&trade; toolkit person detection SSD models, run one of the following commands:
  47
  48 ```sh
  49 ./object_detection_sample_ssd -i <path_to_image>/inputImage.bmp -m <path_to_model>person-detection-retail-0013.xml -d CPU
  50 ```
  51 or
  52 ```sh
  53 ./object_detection_sample_ssd -i <path_to_image>/inputImage.jpg -m <path_to_model>person-detection-retail-0002.xml -d CPU
  54 ```
  55
  56 ## Sample Output
  57
  58 The application outputs an image (`out_0.bmp`) with detected objects enclosed in rectangles. It outputs the list of classes
  59 of the detected objects along with the respective confidence values and the coordinates of the
  60 rectangles to the standard output stream.
  61
  62
  63 ## See Also
  64 * [Using Inference Engine Samples](./docs/IE_DG/Samples_Overview.md)
  65 * [Model Optimizer](./docs/MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md)
  66 * [Model Downloader](https://github.com/opencv/open_model_zoo/tree/2018/model_downloader)