Files
FastDeploy/model_zoo/vision/ppyoloe/api.md
Jason 6ae7a16c36 Add PaddleDetetion/PPYOLOE model support (#22)
* add ppdet/ppyoloe

* Add demo code and documents
2022-07-19 13:40:16 +08:00

2.5 KiB
Raw Blame History

PPYOLOE API说明

Python API

PPYOLOE类

fastdeploy.vision.ultralytics.PPYOLOE(model_file, params_file, config_file, runtime_option=None, model_format=fd.Frontend.PADDLE)

PPYOLOE模型加载和初始化需同时提供model_file和params_file, 当前仅支持model_format为Paddle格式

参数

  • model_file(str): 模型文件路径
  • params_file(str): 参数文件路径
  • config_file(str): 模型推理配置文件
  • runtime_option(RuntimeOption): 后端推理配置默认为None即采用默认配置
  • model_format(Frontend): 模型格式

predict函数

PPYOLOE.predict(image_data, conf_threshold=0.25, nms_iou_threshold=0.5)

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

参数

  • image_data(np.ndarray): 输入数据注意需为HWCBGR格式
  • conf_threshold(float): 检测框置信度过滤阈值
  • nms_iou_threshold(float): NMS处理过程中iou阈值当模型中包含nms处理时此参数自动无效

示例代码参考ppyoloe.py

C++ API

PPYOLOE类

fastdeploy::vision::ultralytics::PPYOLOE(
        const string& model_file,
        const string& params_file,
        const string& config_file,
        const RuntimeOption& runtime_option = RuntimeOption(),
        const Frontend& model_format = Frontend::ONNX)

PPYOLOE模型加载和初始化需同时提供model_file和params_file, 当前仅支持model_format为Paddle格式

参数

  • model_file(str): 模型文件路径
  • params_file(str): 参数文件路径
  • config_file(str): 模型推理配置文件
  • runtime_option(RuntimeOption): 后端推理配置默认为None即采用默认配置
  • model_format(Frontend): 模型格式

Predict函数

YOLOv5::Predict(cv::Mat* im, DetectionResult* result,
                float conf_threshold = 0.25,
                float nms_iou_threshold = 0.5)

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

参数

  • im: 输入图像注意需为HWCBGR格式
  • result: 检测结果,包括检测框,各个框的置信度
  • conf_threshold: 检测框置信度过滤阈值
  • nms_iou_threshold: NMS处理过程中iou阈值(当模型中包含nms处理时此参数自动无效

示例代码参考cpp/yolov5.cc

其它API使用