inference-engine/samples/classification_sample/README.md

   1 # Image Classification C++ Sample
   2
   3 This topic demonstrates how to run the Image Classification sample application, which performs
   4 inference using image classification networks such as AlexNet and GoogLeNet.
   5
   6 > **NOTE:** This topic describes usage of C++ implementation of the Image Classification Sample. For the Python* implementation, refer to [Image Classification Python* Sample](./inference-engine/ie_bridges/python/sample/classification_sample/README.md).
   7
   8 ## How It Works
   9
  10 Upon the start-up, the sample application reads command line parameters and loads a network and an image to the Inference
  11 Engine plugin. When inference is done, the application creates an
  12 output image and outputs data to the standard output stream.
  13
  14 > **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).
  15
  16 ## Running
  17 Running the application with the `-h` option yields the following usage message:
  18 ```sh
  19 ./classification_sample -h
  20 InferenceEngine:
  21     API version ............ <version>
  22     Build .................. <number>
  23
  24 classification_sample [OPTION]
  25 Options:
  26
  27     -h                        Print a usage message.
  28     -i "<path1>" "<path2>"    Required. Path to a folder with images or path to an image files: a .ubyte file for LeNet
  29                               and a .bmp file for the other networks.
  30     -m "<path>"               Required. Path to an .xml file with a trained model.
  31         -l "<absolute_path>"  Required for CPU custom layers. Absolute path to a shared library with the kernels implementations.
  32         Or
  33         -c "<absolute_path>"  Required for GPU custom kernels. Absolute path to the .xml file with the kernels descriptions.
  34     -pp "<path>"              Path to a plugin folder.
  35     -d "<device>"             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
  36     -nt "<integer>"           Number of top results. Default value is 10
  37     -ni "<integer>"           Number of iterations. Default value is 1
  38     -pc                       Enables per-layer performance report
  39     -p_msg                    Enables messages from a plugin
  40
  41 ```
  42
  43 Running the application with the empty list of options yields the usage message given above.
  44
  45 To run the sample, you can use AlexNet and GoogLeNet or other public or pre-trained image classification 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/).
  46
  47 > **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).
  48
  49 For example, to perform inference of an AlexNet model on CPU, use the following command:
  50
  51 ```sh
  52 ./classification_sample -i <path_to_image>/cat.bmp -m <path_to_model>/alexnet_fp32.xml
  53 ```
  54
  55 ## Demo Output
  56
  57 By default the application outputs top-10 inference results.
  58 Add the `-nt` option to the previous command to modify the number of top output results.
  59
  60 For example, to get the top-5 results on GPU, use the following commands:
  61 ```sh
  62 ./classification_sample -i <path_to_image>/cat.bmp -m <path_to_model>/alexnet_fp32.xml -nt 5 -d GPU
  63 ```
  64
  65 ## See Also
  66 * [Using Inference Engine Samples](./docs/IE_DG/Samples_Overview.md)
  67 * [Model Optimizer](./docs/MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md)
  68 * [Model Downloader](https://github.com/opencv/open_model_zoo/tree/2018/model_downloader)