PPQ 是一个高效的工业级神经网络量化工具。 PPQ 被设计为一个灵活而全面的 Onnx 模型量化工具，我们允许你控制对量化进行细致入微的控制，同时严格控制硬件模拟误差。PPQ 有着自定义的量化算子库、网络执行器、神经网络调度器、量化计算图等独特设计，这些组件专为量化而设计，共同构成了这一先进神经网络量化框架。我们将与你一起把人工智慧带到千家万户之间。

目前 PPQ 使用 onnx(opset 11 ~ 13) 模型文件作为输入，覆盖常用的 90 余种 onnx 算子类型。如果你是 Pytorch, tensorflow 的用户，你可以使用这些框架提供的方法将模型转换到 onnx。PPQ 支持向 TensorRT, OpenPPL, Openvino, ncnn, Onnxruntime, Tengine, Snpe, GraphCore 等多个推理引擎生成目标文件并完成部署。PPQ 提供强大的自定义功能，你可以将 PPQ 的量化能力扩展到其他可能的硬件与推理库上。

1. FP8 量化规范，PPQ 现在支持 E4M3, E5M2 等多种规范的 FP8 量化模拟与训练
2. PFL 基础类库，PPQ 现在提供一套更为基础的 api 函数帮助你完成更为灵活的量化
3. 更为强大的 图模式匹配 与 图融合功能
4. 基于 Onnx 的模型 QAT 功能
5. 全新的 TensorRT 量化与导出逻辑
6. 更多正在更新的样例脚本及视频内容
7. 其他未知的软件特性

To release the power of this advanced quantization tool, at least one CUDA computing device is required. Install CUDA from CUDA Toolkit, PPL Quantization Tool will use CUDA compiler to compile cuda kernels at runtime.

ATTENTION: For users of PyTorch, PyTorch might bring you a minimized CUDA libraries, which will not satisfy the requirement of this tool, you have to install CUDA from NVIDIA manually.

ATTENTION: Make sure your Python version is >= 3.6.0. PPL Quantization Tool is written with dialects that only supported by Python >= 3.6.0.

• Install dependencies:

  • For Linux User, use following command to install ninja:

  sudo apt install ninja-build

  • For Windows User:
    • Download ninja.exe from https://github.com/ninja-build/ninja/releases, add it to Windows PATH Environment
    • Download Visual Studio 2019 from https://visualstudio.microsoft.com, if you already got a c++ compiler, you can skip this step.
    • Add your c++ compiler to Windows PATH Environment, if you are using Visual Studio, it should be something like "C:\Program Files\Microsoft Visual Studio\2019\Community\VC\Tools\MSVC\14.16.27023\bin\Hostx86\x86"
    • Update pytorch to 1.10+.

• Install PPQ from source:

Run following code with your terminal(For windows user, use command line instead).

git clone https://github.com/openppl-public/ppq.git
cd ppq
pip install -r requirements.txt
python setup.py install
export PYTHONPATH=${PWD}:${PYTHONPATH}

• Install PPQ from our docker image:

docker pull stephen222/ppq:ubuntu18.04_cuda11.4_cudnn8.4_trt8.4.1.5

docker run -it --rm --ipc=host --gpus all --mount type=bind,source=your custom path,target=/workspace stephen222/ppq:ubuntu18.04_cuda11.4_cudnn8.4_trt8.4.1.5 /bin/bash

git clone https://github.com/openppl-public/ppq.git
cd ppq
export PYTHONPATH=${PWD}:${PYTHONPATH}

• Install PPQ from Pip:

Note that this installation method currently does not support tensorrt write parameter quantization, we haven't updated yet. Wait for Python finish its installation and pray for bug free. pre-built wheels are maintained in PPQ, you could simply install ppq with the following command(You should notice that install from pypi might get an outdated version ....)

python3 -m pip install ppq

WeChat Official Account	QQ Group
OpenPPL	627853444

Email: openppl.ai@hotmail.com

• Sensetime Parrots
• Sensetime Parrots Primitive Libraries
• Sensetime mmlab

We appreciate all contributions. If you are planning to contribute back bug-fixes, please do so without any further discussion.

If you plan to contribute new features, utility functions, or extensions to the core, please first open an issue and discuss the feature with us. Sending a PR without discussion might end up resulting in a rejected PR because we might be taking the core in a different direction than you might be aware of.

PPQ is tested with models from mmlab-classification, mmlab-detection, mmlab-segamentation, mmlab-editing, here we listed part of out testing result.

• No quantization optimization procedure is applied with following models.

• PPQ(sim) stands for PPQ quantization simulator's result.
• Dispatcher stands for dispatching policy of PPQ.
• Classification models are evaluated with ImageNet, Detection and Segamentation models are evaluated with COCO dataset, Editing models are evaluated with DIV2K dataset.
• All calibration datasets are randomly picked from training data.

This project is distributed under the Apache License, Version 2.0.