FastDeploy/examples/vision/detection/yolov5/c/README_CN.md

English | 简体中文

YOLOv5 C 部署示例

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

在部署前，需确认以下两个步骤

• 1. 软硬件环境满足要求，参考FastDeploy环境要求
• 2. 根据开发环境，下载预编译部署库和samples代码，参考FastDeploy预编译库

以Linux上推理为例，在本目录执行如下命令即可完成编译测试，支持此模型需保证FastDeploy版本1.0.4以上(x.x.x>=1.0.4)

# 1. 下载官方转换好的 yolov5 ONNX 模型文件和测试图片
wget https://bj.bcebos.com/paddlehub/fastdeploy/yolov5s.onnx
wget https://gitee.com/paddlepaddle/PaddleDetection/raw/release/2.4/demo/000000014439.jpg

# CPU推理
./infer_demo yolov5s.onnx 000000014439.jpg 0
# GPU推理
./infer_demo yolov5s.onnx 000000014439.jpg 1

以上命令只适用于Linux或MacOS, Windows下SDK的使用方式请参考:

• 如何在Windows中使用FastDeploy C++ SDK

如果用户使用华为昇腾NPU部署, 请参考以下方式在部署前初始化部署环境:

• 如何使用华为昇腾NPU部署

YOLOv5 C API接口

配置

FD_C_RuntimeOptionWrapper* FD_C_CreateRuntimeOptionWrapper()

创建一个RuntimeOption的配置对象，并且返回操作它的指针。

返回

• fd_c_runtime_option_wrapper(FD_C_RuntimeOptionWrapper*): 指向RuntimeOption对象的指针

void FD_C_RuntimeOptionWrapperUseCpu(
     FD_C_RuntimeOptionWrapper* fd_c_runtime_option_wrapper)

开启CPU推理

参数

• fd_c_runtime_option_wrapper(FD_C_RuntimeOptionWrapper*): 指向RuntimeOption对象的指针

void FD_C_RuntimeOptionWrapperUseGpu(
    FD_C_RuntimeOptionWrapper* fd_c_runtime_option_wrapper,
    int gpu_id)

开启GPU推理

参数

• fd_c_runtime_option_wrapper(FD_C_RuntimeOptionWrapper*): 指向RuntimeOption对象的指针
• gpu_id(int): 显卡号

模型

FD_C_YOLOv5Wrapper* FD_C_CreateYOLOv5Wrapper(
    const char* model_file, const char* params_file, const char* config_file,
    FD_C_RuntimeOptionWrapper* runtime_option,
    const FD_C_ModelFormat model_format)

创建一个YOLOv5的模型，并且返回操作它的指针。

参数

• model_file(str): 模型文件路径
• params_file(str): 参数文件路径，当模型格式为ONNX时，此参数传入空字符串即可
• runtime_option(FD_C_RuntimeOptionWrapper*): 指向RuntimeOption的指针，表示后端推理配置
• model_format(FD_C_ModelFormat): 模型格式

返回

• fd_c_yolov5_wrapper(FD_C_YOLOv5Wrapper*): 指向YOLOv5模型对象的指针

读写图像

FD_C_Mat FD_C_Imread(const char* imgpath)

读取一个图像，并且返回cv::Mat的指针。

参数

• imgpath(const char*): 图像文件路径

返回

• imgmat(FD_C_Mat): 指向图像数据cv::Mat的指针。

FD_C_Bool FD_C_Imwrite(const char* savepath,  FD_C_Mat img);

将图像写入文件中。

参数

• savepath(const char*): 保存图像的路径
• img(FD_C_Mat): 指向图像数据的指针

返回

• result(FD_C_Bool): 表示操作是否成功

Predict函数

FD_C_Bool FD_C_YOLOv5WrapperPredict(
    __fd_take FD_C_YOLOv5Wrapper* fd_c_yolov5_wrapper, FD_C_Mat img,
    FD_C_DetectionResult* fd_c_detection_result)

模型预测接口，输入图像直接并生成检测结果。

参数

• fd_c_yolov5_wrapper(FD_C_YOLOv5Wrapper*): 指向YOLOv5模型的指针
• img（FD_C_Mat）: 输入图像的指针，指向cv::Mat对象，可以调用FD_C_Imread读取图像获取
• fd_c_detection_resultFD_C_DetectionResult*): 指向检测结果的指针，检测结果包括检测框，各个框的置信度, DetectionResult说明参考视觉模型预测结果

Predict结果

FD_C_Mat FD_C_VisDetection(FD_C_Mat im, FD_C_DetectionResult* fd_detection_result,
                  float score_threshold, int line_size, float font_size);

对检测结果进行可视化，返回可视化的图像。

参数

• im(FD_C_Mat): 指向输入图像的指针
• fd_detection_result(FD_C_DetectionResult*): 指向FD_C_DetectionResult结构的指针
• score_threshold(float): 检测阈值
• line_size(int): 检测框线大小
• font_size(float): 检测框字体大小

返回

• vis_im(FD_C_Mat): 指向可视化图像的指针

• 模型介绍
• Python部署
• 视觉模型预测结果
• 如何切换模型推理后端引擎