docs: Update docs

RapidAI · Sep 6, 2024 · a441d9c · a441d9c
1 parent 47de013
commit a441d9c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/docs/blog/posts/about_model/custom_different_model.md b/docs/blog/posts/about_model/custom_different_model.md
@@ -2,7 +2,7 @@
 title: 如何更换其他检测和识别模型？
 date:
   created: 2023-10-17
-  updated: 2024-07-18
+  updated: 2024-09-06
 authors: [SWHL]
 categories:
   - 模型相关
@@ -24,11 +24,9 @@ comments: true
 
 这一点在设计时已经做了考虑，留出了接口，这个博客就是以如何更换`rapidocr_onnxruntime`的识别模型为**英文和数字的识别模型**为例做讲解，其他模型同理。
 
-**⚠️注意：使用其他模型的前提条件**：使用的模型必须是PaddleOC文本检测DBNet系列、文本识别CRNN系列模型，这样才能保证前后处理代码可以复用，其他模型不能直接替换模型路径使用。
+**⚠️注意：使用其他模型的前提条件**：使用的模型必须是PaddleOCR中文本检测DBNet系列、文本识别CRNN系列模型，这样才能保证前后处理代码可以复用，其他模型不能直接替换模型路径使用。
 
-!!! note
-
-    检测模型，对应模型路径参数为`det_model_path`<br/>识别模型，对应模型路径参数为`rec_model_path` <br/> 详细说明参见：[link](../../../install_usage/api/RapidOCR.md)
+以下以使用**英文和数字识别模型**为例讲解。
 
 ### 1. 安装`rapidocr_onnxruntime`
 
@@ -58,7 +56,13 @@ pip install rapidocr_onnxruntime
 
 详细教程参见：[link](./convert_model.md)
 
-### 3. 使用该模型
+### 3. 使用模型
+
+!!! note
+
+    检测模型，对应模型路径参数为`det_model_path`<br/>识别模型，对应模型路径参数为`rec_model_path` <br/> 详细说明参见：[link](../../../install_usage/api/RapidOCR.md)
+
+如果得到的识别模型，没有将字典文件写入到ONNX模型中，可以通过初始化RapidOCR类时，通过`rec_keys_path`来指定对应的字典文件。
 
 ```python linenums="1"
 from rapidocr_onnxruntime import RapidOCR

diff --git a/docs/install_usage/api/RapidOCR.md b/docs/install_usage/api/RapidOCR.md
@@ -32,6 +32,7 @@ def __init__(self, text_score: float = 0.5,
     cls_thresh: float = 0.9,
     rec_use_cuda: bool = False,
     rec_use_dml: bool = False,
+    rec_keys_path: Optional[str] = None,
     rec_model_path: Optional[str] = None,
     rec_img_shape: List[int] = [3, 48, 320],
     rec_batch_num: int = 6,
@@ -69,6 +70,7 @@ def __init__(self, text_score: float = 0.5,
 - **cls_thresh** (*float, optional*): 方向分类结果的置信度。取值范围：`[0, 1]`，默认值为0.9。
 - **rec_use_cuda** (*bool, optional*): 是否使用CUDA加速推理。默认值为`False`。
 - **rec_use_dml** (*bool, optional*): 是否使用DirectML加速推理(仅限于Window10及以上)。默认值为`False`。详细参见 → [link](../../blog/posts/how_to_use_directml.md) 。
+- **rec_keys_path** (*bool, optional*): 文本识别模型对应的字典文件，默认为`None`。
 - **rec_model_path** (*Optional[str], optional*): 文本识别模型路径，仅限于PaddleOCR训练文本识别模型。默认值为`None`。
 - **rec_img_shape** (*List[int], optional*): 输入文本识别模型的图像Shape(CHW)。默认值为`[3, 48, 320]`。
 - **rec_batch_num** (*int, optional*): 批次推理的batch大小，一般采用默认值即可，太大并没有明显提速，效果还可能会差。默认值为6。