dcos(rapidocr): update usage

Author: SWHL

docs/install_usage/rapidocr/API/RapidOCR.md

@@ -194,6 +194,14 @@ def __call__(
 
 #### 输出
 
+##### `TextDetOutput`：仅有检测
+
+##### `TextClsOutput`: 仅有文本行方向分类
+
+##### `TextRecOutput`: 仅有识别
+
+##### `RapidOCROutput`: 检测+方向分类+识别
+
 RapidOCR在调用时，有三个参数`use_det | use_cls | use_rec`，可以控制是否使用检测、方向分类和识别这三部分，不同的参数决定了不同的输出。
 
 如果图像中未检测到有效文字信息，则返回`Tuple[None, None]`。详细搭配如下：

docs/install_usage/rapidocr/usage.md

@@ -30,21 +30,65 @@ result.vis()
 
 输入支持传入YAML格式的配置文件，同时支持参数直接传入使用。
 
-=== "传入`config.yaml`使用"
+=== "方法一：传入配置文件"
 
-    1. 生成`default_rapidocr.yaml`的配置文件
+    1. 生成`default_rapidocr.yaml`的配置文件。终端执行以下代码，即可在当前目录下生成默认的`default_rapidocr.yaml`文件。
        ```bash linenums="1"
        $ rapidocr config
+       # The config file has saved in ./default_rapidocr.yaml
        ```
-    2. 根据自己的需要更改YAML相应的值
-    3. 传入到`RapidOCR`中使用
+    2. 根据自己的需要更改YAML相应的值。例如使用openvino作为推理引擎，更改如下：
+       ```yaml linenums="1"
+       # 该配置文件命名为1.yaml
+       Global:
+           lang_det: "ch_mobile" # ch_server
+           lang_rec: "ch_mobile"
+           text_score: 0.5
+
+           use_det: true
+           use_cls: true
+           use_rec: true
+
+           min_height: 30
+           width_height_ratio: 8
+           max_side_len: 2000
+           min_side_len: 30
+
+           return_word_box: false
+
+           with_onnx: false
+           with_openvino: true   # 更改这里为true
+           with_paddle: false
+           with_torch: false
+
+           font_path: null
+      ... ...
+      ```
+    3. 传入到`RapidOCR`中使用。
+       ```python linenums="1"
+       from rapidocr import RapidOCR
+
+       # 步骤2中的1.yaml
+       config_path = "1.yaml"
+       engine = RapidOCR(config_path=config_path)
+
+       img_url = "<https://img1.baidu.com/it/u=3619974146,1266987475&fm=253&fmt=auto&app=138&f=JPEG?w=500&h=516>"
+       result = engine(img_url)
+       print(result)
+
+       result.vis()
+       ```
+
+=== "方法二：直接传入相应参数"
+
+    由于rapidocr中涉及可调节的参数众多，为了便于维护，引入[omageconf](https://github.com/omry/omegaconf)库来更新参数。这样带来的代价是传入参数没有1.x系列中直观一些。但是现阶段方式也容易理解和使用。
 
-=== "直接传入参数"
+    例如，我想使用openvino作为推理引擎，可以通过下面这种方式使用：
 
     ```python linenums="1"
     from rapidocr import RapidOCR
 
-    engine = RapidOCR()
+    engine = RapidOCR(params={"Global.with_openvino": True})
 
     img_url = "https://github.com/RapidAI/RapidOCR/blob/main/python/tests/test_files/ch_en_num.jpg?raw=true"
     result = engine(img_url)
@@ -53,10 +97,61 @@ result.vis()
     result.vis()
     ```
 
+    其他参数传入方式，基本就是参考`config.yaml`，关键字之间用点分割，直接写就可以了。例如：
+    ```python linenums="1"
+    {
+      "Global.with_openvino": True,
+      "Global.use_det": True,
+      "EngineConfig.torch.use_cuda", True,  # 使用torch GPU版推理
+      "EngineConfig.torch.gpu_id": 1,  # 指定GPU id
+    }
+    ```
+
 #### 输出
 
+RapidOCR输出包括4种类型：`Union[TextDetOutput, TextClsOutput, TextRecOutput, RapidOCROutput]`。这4种类型均是Dataclasses类，可以直接访问对应的键值。
+
 #### 选择不同推理引擎
 
+`rapidocr`支持4种推理引擎（ONNXRuntime / OpenVINO / PaddlePaddle / PyTorch），默认使用ONNXRuntime CPU版。
+
+`rapidocr`是通过指定不同参数来选择使用不同的推理引擎的。当然，使用不同推理引擎的前提是事先安装好对应的推理引擎库，并确保安装正确。
+
+=== "使用ONNXRuntime"
+
+    在安装`rapidocr`时，已经自动安装好了，无需配置，可直接使用。
+
+=== "使用OpenVINO"
+
+    1. 安装openvino
+       ```bash linenums="1"
+       pip install openvino
+       ```
+    2. 指定openvino作为推理引擎
+       ```python linenums="1"
+       from rapidocr import RapidOCR
+
+       engine = RapidOCR(params={"Global.with_openvino": True})
+
+       img_url = "https://github.com/RapidAI/RapidOCR/blob/main/python/tests/ test_files/ch_en_num.jpg?raw=true"
+       result = engine(img_url)
+       print(result)
+
+       result.vis()
+       ```
+    3. 查看输出日志。下面日志中打印出了**Using engine_name: openvino**，则证明使用的推理引擎是OpenVINO。
+      ```bash linenums="1"
+      [INFO] 2025-03-21 09:28:03,457 base.py:30: Using engine_name: openvino
+      [INFO] 2025-03-21 09:28:03,553 utils.py:35: File already exists in /Users/joshuawang/projects/_self/RapidOCR/python/rapidocr/models/ch_PP-OCRv4_det_infer.onnx
+      [INFO] 2025-03-21 09:28:03,767 base.py:30: Using engine_name: openvino
+      [INFO] 2025-03-21 09:28:03,768 utils.py:35: File already exists in /Users/joshuawang/projects/_self/RapidOCR/python/rapidocr/models/ch_ppocr_mobile_v2.0_cls_infer.onnx
+      [INFO] 2025-03-21 09:28:03,861 base.py:30: Using engine_name: openvino
+      [INFO] 2025-03-21 09:28:03,862 utils.py:35: File already exists in /Users/joshuawang/projects/_self/RapidOCR/python/rapidocr/models/ch_PP-OCRv4_rec_infer.onnx
+      ```
+
+=== "使用PaddlePaddle"
+=== "使用PyTorch"
+
 #### 选择CPU / GPU
 
 #### 使用默认mobiel或server模型