openvino/inference-engine/ie_bridges/python
Maksim Makridin f8d36c55a8
Fixes for Object Detection SSD samples docs (C++ and Python) (#4286)
* Fixes for Object Detection SSD samples docs (C++ and Python)

* fixes from code review

* Fixes for Object Detection SSD samples docs (C++ and Python)

* fixes from code review

* fixes from code review
2021-02-11 17:51:53 +03:00
..
cmake Introduce IEDevScripts package (#3661) 2020-12-22 18:44:59 +03:00
docs Doc Migration (master) (#1377) 2020-07-20 17:36:08 +03:00
sample Fixes for Object Detection SSD samples docs (C++ and Python) (#4286) 2021-02-11 17:51:53 +03:00
src Enabled wheel packaging (#3582) 2021-02-08 19:16:28 +03:00
tests [Python API] Support of FP16 blobs (#3893) 2021-02-01 09:12:32 +03:00
wheel Enabled wheel packaging (#3582) 2021-02-08 19:16:28 +03:00
CMakeLists.txt Enabled wheel packaging (#3582) 2021-02-08 19:16:28 +03:00
README.md Enabled wheel packaging (#3582) 2021-02-08 19:16:28 +03:00
requirements.txt [Python API] requirements (#1804) 2020-12-16 17:06:32 +03:00

README.md

Software Requirements

  • CMake* 3.9 or later
  • Microsoft* Visual Studio 2015 or later on Windows*
  • gcc 4.8 or later on Linux
  • Python 2.7 or higher on Linux*
  • Python 3.6 or higher on Windows*

Prerequisites

  1. Install Inference Engine Python API dependencies:
pip3 install -r requirements.txt

Building on Linux

Build Inference Engine Python API alongside with the Inference Engine build. You need to run Inference Engine build with the following flags:

  cd <IE_ROOT>
  mkdir -p build
  cd build
  cmake -DENABLE_PYTHON=ON -DPYTHON_EXECUTABLE=`which python3.6` \
  	-DPYTHON_LIBRARY=/usr/lib/x86_64-linux-gnu/libpython3.6m.so \
  	-DPYTHON_INCLUDE_DIR=/usr/include/python3.6 ..
  make -j16

Building on Windows

You need to run Inference Engine build with the following flags:

	cd <IE_ROOT>
	mkdir build
	cd build
	set PATH=C:\Program Files\Python36\Scripts;%PATH%
	cmake -G "Visual Studio 15 2017 Win64" ^
		-DENABLE_PYTHON=ON ^
		-DPYTHON_EXECUTABLE="C:\Program Files\Python36\python.exe" ^
		-DPYTHON_INCLUDE_DIR="C:\Program Files\Python36\include" ^
		-DPYTHON_LIBRARY="C:\Program Files\Python36\libs\python36.lib" ..

Then build generated solution INFERENCE_ENGINE_DRIVER.sln using Microsoft* Visual Studio or run cmake --build . --config Release to build from the command line.

Building Python wheel

  1. Install Inference Engine Python API dependencies:
pip3 install -r wheel/requirements-dev.txt
  1. Install the patchelf tool on Linux only:
sudo apt install patchelf
  1. Run Inference Engine build with the following options:
-DENABLE_PYTHON=ON
-DENABLE_WHEEL=ON

If you need to include other components to the package you need to enable them too. For example, to include ngraph python API:

-NGRAPH_PYTHON_BUILD_ENABLE=ON

Running sample

Before running the Python samples:

  • add the folder with built openvino Python module (located at bin/intel64/Release/lib/python_api/python3.6 for Linux) to the PYTHONPATH environment variable.
  • add the folder with Inference Engine libraries to LD_LIBRARY_PATH variable on Linux (or PATH on Windows).

Example of command line to run classification sample:

python3 sample/classification_sample.py -m <path/to/xml> -i <path/to/input/image> -d CPU