From 3a9904411afd85479f39a8ce11db38780d37f76f Mon Sep 17 00:00:00 2001 From: co63oc Date: Mon, 29 May 2023 13:43:54 +0800 Subject: [PATCH] [C API] Fix some c api document typos (#1997) --- benchmark/python/benchmark_ppocr.py | 2 +- benchmark/python/benchmark_ppseg.py | 2 +- benchmark/python/benchmark_yolo.py | 2 +- .../fastdeploy_capi/vision/ocr/ppocr/model.h | 24 +++++++++---------- c_api/fastdeploy_capi/vision/result.h | 8 +++---- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/benchmark/python/benchmark_ppocr.py b/benchmark/python/benchmark_ppocr.py index cff4d2e88d..5abda9a505 100755 --- a/benchmark/python/benchmark_ppocr.py +++ b/benchmark/python/benchmark_ppocr.py @@ -53,7 +53,7 @@ def parse_arguments(): required=True, type=int, default=300, - help="number of iterations for computing performace.") + help="number of iterations for computing performance.") parser.add_argument( "--device", default="cpu", diff --git a/benchmark/python/benchmark_ppseg.py b/benchmark/python/benchmark_ppseg.py index 90192b47ce..67f5bfab8d 100755 --- a/benchmark/python/benchmark_ppseg.py +++ b/benchmark/python/benchmark_ppseg.py @@ -39,7 +39,7 @@ def parse_arguments(): required=True, type=int, default=300, - help="number of iterations for computing performace.") + help="number of iterations for computing performance.") parser.add_argument( "--device", default="cpu", diff --git a/benchmark/python/benchmark_yolo.py b/benchmark/python/benchmark_yolo.py index a071272002..fcb782f56d 100755 --- a/benchmark/python/benchmark_yolo.py +++ b/benchmark/python/benchmark_yolo.py @@ -41,7 +41,7 @@ def parse_arguments(): required=True, type=int, default=300, - help="number of iterations for computing performace.") + help="number of iterations for computing performance.") parser.add_argument( "--device", default="cpu", diff --git a/c_api/fastdeploy_capi/vision/ocr/ppocr/model.h b/c_api/fastdeploy_capi/vision/ocr/ppocr/model.h index 0963e1ede2..1272152aee 100644 --- a/c_api/fastdeploy_capi/vision/ocr/ppocr/model.h +++ b/c_api/fastdeploy_capi/vision/ocr/ppocr/model.h @@ -57,7 +57,7 @@ OCR_DECLARE_DESTROY_WRAPPER_FUNCTION(Recognizer, fd_c_recognizer_wrapper); * \param[in] fd_c_recognizer_wrapper pointer to FD_C_RecognizerWrapper object * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. * \param[in] text The text result of rec model will be written into this parameter. - * \param[in] rec_score The sccore result of rec model will be written into this parameter. + * \param[in] rec_score The score result of rec model will be written into this parameter. * \return true if the prediction is successed, otherwise false. */ @@ -79,7 +79,7 @@ OCR_DECLARE_INITIALIZED_FUNCTION(Recognizer, fd_c_recognizer_wrapper); * \param[in] fd_c_recognizer_wrapper pointer to FD_C_RecognizerWrapper object * \param[in] imgs The list of input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. * \param[in] texts The list of text results of rec model will be written into this vector. - * \param[in] rec_scores The list of sccore result of rec model will be written into this vector. + * \param[in] rec_scores The list of score result of rec model will be written into this vector. * * \return true if the prediction successed, otherwise false */ @@ -194,7 +194,7 @@ OCR_DECLARE_DESTROY_WRAPPER_FUNCTION(DBDetector, fd_c_dbdetector_wrapper); * * \param[in] fd_c_dbdetector_wrapper pointer to FD_C_DBDetectorWrapper object * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] boxes_result The output of OCR detection model result will be writen to this structure. + * \param[in] boxes_result The output of OCR detection model result will be written to this structure. * \return true if the prediction is successed, otherwise false. */ @@ -215,7 +215,7 @@ OCR_DECLARE_INITIALIZED_FUNCTION(DBDetector, fd_c_dbdetector_wrapper); * * \param[in] fd_c_dbdetector_wrapper pointer to FD_C_DBDetectorWrapper object * \param[in] imgs The list input of image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] det_results The output of OCR detection model result will be writen to this structure. + * \param[in] det_results The output of OCR detection model result will be written to this structure. * * \return true if the prediction is successed, otherwise false. */ @@ -256,7 +256,7 @@ OCR_DECLARE_DESTROY_WRAPPER_FUNCTION(StructureV2Table, fd_c_structurev2table_wra * * \param[in] fd_c_structurev2table_wrapper pointer to FD_C_StructureV2TableWrapper object * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] boxes_result The output of OCR table model result will be writen to this structure. + * \param[in] boxes_result The output of OCR table model result will be written to this structure. * \return true if the prediction is successed, otherwise false. */ @@ -277,7 +277,7 @@ OCR_DECLARE_INITIALIZED_FUNCTION(StructureV2Table, fd_c_structurev2table_wrapper * * \param[in] fd_c_structurev2table_wrapper pointer to FD_C_StructureV2TableWrapper object * \param[in] imgs The list input of image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] det_results The output of OCR table model result will be writen to this structure. + * \param[in] det_results The output of OCR table model result will be written to this structure. * * \return true if the prediction is successed, otherwise false. */ @@ -316,7 +316,7 @@ OCR_DECLARE_DESTROY_WRAPPER_FUNCTION(PPOCRv2, fd_c_ppocrv2_wrapper); * * \param[in] fd_c_ppocrv2_wrapper pointer to FD_C_PPOCRv2Wrapper object * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] result The output OCR result will be writen to this structure. + * \param[in] result The output OCR result will be written to this structure. * \return true if the prediction successed, otherwise false. */ @@ -337,7 +337,7 @@ OCR_DECLARE_INITIALIZED_FUNCTION(PPOCRv2, fd_c_ppocrv2_wrapper); * * \param[in] fd_c_ppocrv2_wrapper pointer to FD_C_PPOCRv2Wrapper object * \param[in] imgs The list of input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] batch_result The output list of OCR result will be writen to this structure. + * \param[in] batch_result The output list of OCR result will be written to this structure. * \return true if the prediction successed, otherwise false. */ @@ -375,7 +375,7 @@ OCR_DECLARE_DESTROY_WRAPPER_FUNCTION(PPOCRv3, fd_c_ppocrv3_wrapper); * * \param[in] fd_c_ppocrv3_wrapper pointer to FD_C_PPOCRv3Wrapper object * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] result The output OCR result will be writen to this structure. + * \param[in] result The output OCR result will be written to this structure. * \return true if the prediction successed, otherwise false. */ @@ -396,7 +396,7 @@ OCR_DECLARE_INITIALIZED_FUNCTION(PPOCRv3, fd_c_ppocrv3_wrapper); * * \param[in] fd_c_ppocrv3_wrapper pointer to FD_C_PPOCRv3Wrapper object * \param[in] imgs The list of input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] batch_result The output list of OCR result will be writen to this structure. + * \param[in] batch_result The output list of OCR result will be written to this structure. * \return true if the prediction successed, otherwise false. */ @@ -433,7 +433,7 @@ OCR_DECLARE_DESTROY_WRAPPER_FUNCTION(PPStructureV2Table, fd_c_ppstructurev2table * * \param[in] fd_c_ppstructurev2table_wrapper pointer to FD_C_PPStructureV2TableWrapper object * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] result The output OCR result will be writen to this structure. + * \param[in] result The output OCR result will be written to this structure. * \return true if the prediction successed, otherwise false. */ @@ -454,7 +454,7 @@ OCR_DECLARE_INITIALIZED_FUNCTION(PPStructureV2Table, fd_c_ppstructurev2table_wra * * \param[in] fd_c_ppstructurev2table_wrapper pointer to FD_C_PPStructureV2TableWrapper object * \param[in] imgs The list of input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. - * \param[in] batch_result The output list of OCR result will be writen to this structure. + * \param[in] batch_result The output list of OCR result will be written to this structure. * \return true if the prediction successed, otherwise false. */ diff --git a/c_api/fastdeploy_capi/vision/result.h b/c_api/fastdeploy_capi/vision/result.h index a8f780abd5..f55c9338b7 100644 --- a/c_api/fastdeploy_capi/vision/result.h +++ b/c_api/fastdeploy_capi/vision/result.h @@ -149,7 +149,7 @@ FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_ClassifyResultWrapper* FD_C_CreateClassifyResultWrapperFromCResult( __fd_keep FD_C_ClassifyResult* fd_c_classify_result); -/** \brief Print ClassifyResult formated information +/** \brief Print ClassifyResult formatted information * * \param[in] fd_c_classify_result pointer to FD_C_ClassifyResult object * \param[out] str_buffer used to store string @@ -216,7 +216,7 @@ FD_C_CreateDetectionResultWrapperFromCResult( __fd_keep FD_C_DetectionResult* fd_c_detection_result); -/** \brief Print DetectionResult formated information +/** \brief Print DetectionResult formatted information * * \param[in] fd_c_detection_result pointer to FD_C_DetectionResult object * \param[out] str_buffer used to store string @@ -281,7 +281,7 @@ FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_OCRResultWrapper* FD_C_CreateOCRResultWrapperFromCResult( __fd_keep FD_C_OCRResult* fd_c_ocr_result); -/** \brief Print OCRResult formated information +/** \brief Print OCRResult formatted information * * \param[in] fd_c_ocr_result pointer to FD_C_OCRResult object * \param[out] str_buffer used to store string @@ -345,7 +345,7 @@ FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_SegmentationResultWrapper* FD_C_CreateSegmentationResultWrapperFromCResult( __fd_keep FD_C_SegmentationResult* fd_c_segmentation_result); -/** \brief Print SegmentationResult formated information +/** \brief Print SegmentationResult formatted information * * \param[in] fd_c_segmentation_result pointer to FD_C_SegmentationResult object * \param[out] str_buffer used to store string