ncnn/python/README.md

ncnn

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

Prerequisites

On Unix (Linux, OS X)

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

On Windows

• Visual Studio 2015 or higher
• CMake >= 3.4

Build

1. clone ncnn and init submodule.

cd /pathto/ncnn
git submodule init && git submodule update

2. build.

mkdir build
cd build
cmake -DNCNN_PYTHON=ON ..
make

Install

cd /pathto/ncnn/python
pip install .

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

cd /pathto/ncnn/python
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())

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