diff --git a/examples/vision/ocr/PP-OCRv3/python/README.md b/examples/vision/ocr/PP-OCRv3/python/README.md index a51abba98..280ae7016 100644 --- a/examples/vision/ocr/PP-OCRv3/python/README.md +++ b/examples/vision/ocr/PP-OCRv3/python/README.md @@ -38,89 +38,12 @@ python infer.py --det_model ch_PP-OCRv3_det_infer --cls_model ch_ppocr_mobile_v2 运行完成可视化结果如下图所示 -## PPOCRv3 Python接口 - -``` -fd.vision.ocr.PPOCRv3(det_model=det_model, cls_model=cls_model, rec_model=rec_model) -``` -PPOCRv3的初始化,输入的参数是检测模型,分类模型和识别模型,其中cls_model可选,如无需求,可设置为None - -**参数** - -> * **det_model**(model): OCR中的检测模型 -> * **cls_model**(model): OCR中的分类模型 -> * **rec_model**(model): OCR中的识别模型 - -### predict函数 - -> ``` -> result = ppocr_v3.predict(im) -> ``` -> -> 模型预测接口,输入是一张图片 -> -> **参数** -> -> > * **im**(np.ndarray): 输入数据,每张图片注意需为HWC,BGR格式 - -> **返回** -> -> > 返回`fastdeploy.vision.OCRResult`结构体,结构体说明参考文档[视觉模型预测结果](../../../../../docs/api/vision_results/) - - - -## DBDetector Python接口 - -### DBDetector类 - -``` -fastdeploy.vision.ocr.DBDetector(model_file, params_file, runtime_option=None, model_format=ModelFormat.PADDLE) -``` - -DBDetector模型加载和初始化,其中模型为paddle模型格式。 - -**参数** - -> * **model_file**(str): 模型文件路径 -> * **params_file**(str): 参数文件路径,当模型格式为ONNX时,此参数传入空字符串即可 -> * **runtime_option**(RuntimeOption): 后端推理配置,默认为None,即采用默认配置 -> * **model_format**(ModelFormat): 模型格式,默认为PADDLE格式 - -### Classifier类与DBDetector类相同 - -### Recognizer类 -``` -fastdeploy.vision.ocr.Recognizer(rec_model_file,rec_params_file,rec_label_file, - runtime_option=rec_runtime_option,model_format=ModelFormat.PADDLE) -``` -Recognizer类初始化时,需要在rec_label_file参数中,输入识别模型所需的label文件路径,其他参数均与DBDetector类相同 - -**参数** -> * **label_path**(str): 识别模型的label文件路径 - - - -### 类成员变量 - -#### DBDetector预处理参数 -用户可按照自己的实际需求,修改下列预处理参数,从而影响最终的推理和部署效果 - -> > * **max_side_len**(int): 检测算法前向时图片长边的最大尺寸,当长边超出这个值时会将长边resize到这个大小,短边等比例缩放,默认为960 -> > * **det_db_thresh**(double): DB模型输出预测图的二值化阈值,默认为0.3 -> > * **det_db_box_thresh**(double): DB模型输出框的阈值,低于此值的预测框会被丢弃,默认为0.6 -> > * **det_db_unclip_ratio**(double): DB模型输出框扩大的比例,默认为1.5 -> > * **det_db_score_mode**(string):DB后处理中计算文本框平均得分的方式,默认为slow,即求polygon区域的平均分数的方式 -> > * **use_dilation**(bool):是否对检测输出的feature map做膨胀处理,默认为Fasle - -#### Classifier预处理参数 -用户可按照自己的实际需求,修改下列预处理参数,从而影响最终的推理和部署效果 - -> > * **cls_thresh**(double): 当分类模型输出的得分超过此阈值,输入的图片将被翻转,默认为0.9 ## 其它文档 +- [Python API文档查阅](https://baidu-paddle.github.io/fastdeploy-api/python/html/) - [PPOCR 系列模型介绍](../../) - [PPOCRv3 C++部署](../cpp) - [模型预测结果说明](../../../../../docs/api/vision_results/)