History

jzhang533 24f06d1a1b update common pre-commit configs and commit the results of running pre-commit run -a (#12516 )		2024-05-29 15:26:09 +08:00
..
CMakeLists.txt	[FastDeploy] Add FastDeploy support to deploy PaddleOCR models. (#9260 )	2023-03-03 14:51:09 +08:00
README.md	update common pre-commit configs and commit the results of running pre-commit run -a (#12516 )	2024-05-29 15:26:09 +08:00
infer.cs	update common pre-commit configs and commit the results of running pre-commit run -a (#12516 )	2024-05-29 15:26:09 +08:00

README.md

English | 简体中文

PaddleOCR CPU-GPU C#部署示例

本目录下提供infer.cs来调用C# API快速完成PPOCRv3模型在CPU/GPU上部署的示例。

1. 说明

PaddleOCR支持利用FastDeploy在NVIDIA GPU、X86 CPU、飞腾CPU、ARM CPU、Intel GPU(独立显卡/集成显卡)硬件上快速部署OCR模型.

2. 部署环境准备

在部署前，需确认软硬件环境，同时下载预编译部署库，参考FastDeploy安装文档安装FastDeploy预编译库. 在本目录执行如下命令即可在Windows完成编译测试，支持此模型需保证FastDeploy版本1.0.4以上(x.x.x>=1.0.4)

3. 部署模型准备

在部署前, 请准备好您所需要运行的推理模型, 您可以在FastDeploy支持的PaddleOCR模型列表中下载所需模型.

4. 部署示例

4.1 下载C#包管理程序nuget客户端

https://dist.nuget.org/win-x86-commandline/v6.4.0/nuget.exe 下载完成后将该程序添加到环境变量PATH中

4.2. 下载模型文件和测试图片

https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_det_infer.tar # (下载后解压缩) https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_cls_infer.tar https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_rec_infer.tar https://gitee.com/paddlepaddle/PaddleOCR/raw/release/2.6/doc/imgs/12.jpg https://gitee.com/paddlepaddle/PaddleOCR/raw/release/2.6/ppocr/utils/ppocr_keys_v1.txt

4.3 编译示例代码

本文档编译的示例代码的编译工具依赖VS 2019，Windows打开x64 Native Tools Command Prompt for VS 2019命令工具，通过如下命令开始编译

## 下载FastDeploy预编译库，用户可在上文提到的`FastDeploy预编译库`中自行选择合适的版本使用
https://bj.bcebos.com/fastdeploy/release/cpp/fastdeploy-linux-x64-x.x.x.tgz

# 下载部署示例代码
git clone https://github.com/PaddlePaddle/FastDeploy.git
cd D:\FastDeploy\examples\vision\ocr\PP-OCR\cpu-gpu\csharp

# 如果您希望从PaddleOCR下载示例代码，请运行
git clone https://github.com/PaddlePaddle/PaddleOCR.git
# 注意：如果当前分支找不到下面的fastdeploy测试代码，请切换到dygraph分支
git checkout dygraph
cd D:\PaddleOCR\deploy\fastdeploy\cpu-gpu\csharp

mkdir build && cd build
cmake .. -G "Visual Studio 16 2019" -A x64 -DFASTDEPLOY_INSTALL_DIR=D:\fastdeploy-win-x64-gpu-x.x.x -DCUDA_DIRECTORY="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.2"

nuget restore
msbuild infer_demo.sln /m:4 /p:Configuration=Release /p:Platform=x64

关于使用Visual Studio 2019创建sln工程，或者CMake工程等方式编译的更详细信息，可参考如下文档

4.4 运行可执行程序

注意Windows上运行时，需要将FastDeploy依赖的库拷贝至可执行程序所在目录, 或者配置环境变量。FastDeploy提供了工具帮助我们快速将所有依赖库拷贝至可执行程序所在目录,通过如下命令将所有依赖的dll文件拷贝至可执行程序所在的目录(可能生成的可执行文件在Release下还有一层目录，这里假设生成的可执行文件在Release处)

cd D:\fastdeploy-win-x64-gpu-x.x.x

fastdeploy_init.bat install %cd% D:\PaddleOCR\deploy\fastdeploy\cpu-gpu\csharp\build\Release

将dll拷贝到当前路径后，准备好模型和图片，使用如下命令运行可执行程序即可

cd Release
# CPU推理
infer_demo ./ch_PP-OCRv3_det_infer ./ch_ppocr_mobile_v3.0_cls_infer ./ch_PP-OCRv3_rec_infer ./ppocr_keys_v1.txt ./12.jpg 0
# GPU推理
infer_demo ./ch_PP-OCRv3_det_infer ./ch_ppocr_mobile_v3.0_cls_infer ./ch_PP-OCRv3_rec_infer ./ppocr_keys_v1.txt ./12.jpg 1

5. PP-OCRv3 C# API接口简介

下面提供了PP-OCRv3的C# API简介

如果用户想要更换部署后端或进行其他定制化操作, 请查看C# Runtime API.
更多 PP-OCR C# API 请查看 C# PP-OCR API

模型

fastdeploy.vision.ocr.DBDetector(
        string model_file,
        string params_file,
        fastdeploy.RuntimeOption runtime_option = null,
        fastdeploy.ModelFormat model_format = ModelFormat.PADDLE)

DBDetector模型加载和初始化。

参数

model_file(str): 模型文件路径

params_file(str): 参数文件路径

runtime_option(RuntimeOption): 后端推理配置，默认为null，即采用默认配置

model_format(ModelFormat): 模型格式，默认为PADDLE格式

fastdeploy.vision.ocr.Classifier(
        string model_file,
        string params_file,
        fastdeploy.RuntimeOption runtime_option = null,
        fastdeploy.ModelFormat model_format = ModelFormat.PADDLE)

Classifier模型加载和初始化。

参数

model_file(str): 模型文件路径

params_file(str): 参数文件路径

runtime_option(RuntimeOption): 后端推理配置，默认为null，即采用默认配置

model_format(ModelFormat): 模型格式，默认为PADDLE格式

fastdeploy.vision.ocr.Recognizer(
        string model_file,
        string params_file,
        string label_path,
        fastdeploy.RuntimeOption runtime_option = null,
        fastdeploy.ModelFormat model_format = ModelFormat.PADDLE)

Recognizer模型加载和初始化。

参数

model_file(str): 模型文件路径

params_file(str): 参数文件路径

label_path(str): 标签文件路径

runtime_option(RuntimeOption): 后端推理配置，默认为null，即采用默认配置

model_format(ModelFormat): 模型格式，默认为PADDLE格式

fastdeploy.pipeline.PPOCRv3Model(
        DBDetector dbdetector,
        Classifier classifier,
        Recognizer recognizer)

PP-OCRv3Model模型加载和初始化。

参数

det_model(FD_C_DBDetectorWrapper*): DBDetector模型

cls_model(FD_C_ClassifierWrapper*): Classifier模型

rec_model(FD_C_RecognizerWrapper*): Recognizer模型文件

Predict函数

fastdeploy.OCRResult Predict(OpenCvSharp.Mat im)

模型预测接口，输入图像直接输出结果。

参数

im(Mat): 输入图像，注意需为HWC，BGR格式

返回值

result: OCR预测结果,包括由检测模型输出的检测框位置,分类模型输出的方向分类,以及识别模型输出的识别结果, OCRResult说明参考视觉模型预测结果

README.md Unescape Escape