ncnn/python at master · Tencent/ncnn · GitHub
Skip to content

python

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

python

Folders and files

README.md

ncnn

python wrapper of ncnn with pybind11, only support python3.x now.

Install from pip

ncnn is available as wheel packages for macOS, Windows and Linux distributions, you can install with pip:

python -m pip install -U pip
python -m pip install -U ncnn

The base ncnn package does not require OpenCV. Core inference, model imports, and print_topk work without it. Drawing helpers and Yolact inference require a compatible cv2 module. To install the optional OpenCV dependency:

python -m pip install -U "ncnn[opencv]"

If your environment already provides cv2 through a system package, a custom build, or opencv-python-headless, install plain ncnn instead. Do not install multiple OpenCV distributions together; they share the same cv2 namespace. The drawing helpers use imshow and waitKey, so they also require an OpenCV build with GUI support and a working display. Headless builds can be used for Yolact, but cannot display the drawing helpers' windows.

Mobile wheels

The release-python.yml workflow builds CPython 3.13, 3.14, and 3.15 CPU-only wheels for Android API 24 and later, and iOS 14.0 and later. It collects these wheels with the desktop wheels for the existing PyPI upload step. Vulkan and OpenMP are disabled. Android arm64 and iOS device wheels are build-only; emulator/simulator tests run only where the host architecture is supported.

The mobile smoke test installs the wheel without runtime dependencies and checks import, tensor access, and a small ReLU network without model downloads. This does not validate a normal pip install ncnn, NumPy interoperability, or the model zoo on mobile. Required dependencies such as NumPy need compatible mobile builds for the selected Python version; the workflow does not configure supplemental package indexes. A compatible mobile cv2 build is also needed for OpenCV-dependent features; the opencv extra alone does not supply one on these platforms.

Build from source

If you want to build ncnn with some options not as default, or just like to build everything yourself, it is not difficult to build ncnn from source.

Prerequisites

On Unix (Linux, OS X)

  • A compiler with C++11 support
  • CMake >= 3.4

On Mac

  • A compiler with C++11 support
  • CMake >= 3.4

On Windows

  • Visual Studio 2015 or higher
  • CMake >= 3.4

Build & Install

  1. clone ncnn and init submodule.
cd /pathto/ncnn
git submodule init && git submodule update
  1. build and install.
python setup.py install

If you want to use a custom toolchain, you can install with the CMAKE_TOOLCHAIN_FILE environment variable, like this:

CMAKE_TOOLCHAIN_FILE="../../toolchains/power9le-linux-gnu-vsx.clang.toolchain.cmake" python setup.py install

if you want to enable the usage of vulkan, you can install as following:

python setup.py install --vulkan=on

Attention:

To enable Vulkan support, you must first install the Vulkan SDK.

For Windows or Linux Users:

Ensure that the VULKAN_SDK environment variable is set to the path of the Vulkan SDK.

For MacOS Users:

On MacOS, you will need to specify additional environment variables. For guidance on setting these variables, please refer to lines 279-286 in the following file: ncnn/.github/workflows/release-python.yml at master · Tencent/ncnn.

Custom-build & Install

  1. clone ncnn and init submodule.
cd /pathto/ncnn
git submodule init && git submodule update
  1. build.
mkdir build
cd build
cmake -DNCNN_PYTHON=ON ..
make

To use the pybind11 package provided by your system, set the CMake variable NCNN_SYSTEM_PYBIND11 to ON during the build process, like this:

mkdir build
cd build
cmake -DNCNN_PYTHON=ON -DNCNN_SYSTEM_PYBIND11=ON ..
make
  1. install
cd /pathto/ncnn
pip install .

if you use conda or miniconda, you can also install as following:

cd /pathto/ncnn
python3 setup.py install

Tests

test

cd /pathto/ncnn/python
python3 tests/test.py

benchmark

cd /pathto/ncnn/python
python3 tests/benchmark.py

Numpy

ncnn.Mat->numpy.array, with no memory copy

mat = ncnn.Mat(...)
mat_np = np.array(mat)

numpy.array->ncnn.Mat, with no memory copy

mat_np = np.array(...)
mat = ncnn.Mat(mat_np)

Model Zoo

install requirements

pip install -r requirements.txt

then you can import ncnn.model_zoo and get model list as follow:

import ncnn
import ncnn.model_zoo as model_zoo

print(model_zoo.get_model_list())

models now in model zoo are as list below:

mobilenet_yolov2
mobilenetv2_yolov3
yolov4_tiny
yolov4
yolov5s
yolact
mobilenet_ssd
squeezenet_ssd
mobilenetv2_ssdlite
mobilenetv3_ssdlite
squeezenet
faster_rcnn
peleenet_ssd
retinaface
rfcn
shufflenetv2
simplepose
nanodet

all model in model zoo has example in ncnn/python/examples folder

Custom Layer

custom layer demo is in ncnn/python/ncnn/model_zoo/yolov5.py:23