Skip to content

Commit

Permalink
docs: update RapidOCR api
Browse files Browse the repository at this point in the history
  • Loading branch information
SWHL committed Dec 16, 2024
1 parent 098a21b commit ad1f46a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/install_usage/api/RapidOCR.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def __init__(self, text_score: float = 0.5,
- **width_height_ratio** (*float, optional*): 如果输入图像的宽高比大于`width_height_ratio`,则会跳过文本检测,直接进行后续识别,取值为-1时:不用这个参数. 默认值为8。
- **max_side_len** (*int, optional*): 如果输入图像的最大边大于`max_side_len`,则会按宽高比,将最大边缩放到`max_side_len`。默认为2000px。
- **min_side_len** (*int, optional*): 如果输入图像的最小边小于`min_side_len`,则会按宽高比,将最小边缩放到`min_side_len`。默认为30px。
- **return_word_box** (*bool, optional*): 是否返回文字的单字坐标。默认为`False`。汉字会返回单字坐标,英语返回单词坐标。
- **return_word_box** (*bool, optional*): 是否返回文字的单字坐标。默认为`False``rapidocr_onnxruntime==1.4.0`中,汉字会返回单字坐标,英语返回单词坐标。在`rapidocr_onnxruntime>=1.4.1`中,汉字返回单字坐标,英语返回单字母坐标
- **det_use_cuda** (*bool, optional*): 是否使用CUDA加速推理。默认值为`False`
- **det_use_dml** (*bool, optional*): 是否使用DirectML加速推理(仅限于Window10及以上)。默认值为`False`。详细参见 → [link](../../blog/posts/how_to_use_directml.md)
- **det_model_path** (*Optional[str], optional*): 文本检测模型路径,仅限于基于PaddleOCR训练所得DBNet文本检测模型。默认值为`None`
Expand Down Expand Up @@ -200,7 +200,7 @@ RapidOCR在调用时,有三个参数`use_det | use_cls | use_rec`,可以控

=== "返回单字坐标"

⚠️注意:汉字是单字坐标,英语是单词坐标。 在`rapidocr_onnxruntime>=1.4.0`中支持
⚠️注意:在`rapidocr_onnxruntime==1.4.0`中,汉字会返回单字坐标,英语返回单词坐标。在`rapidocr_onnxruntime>=1.4.1`中,汉字返回单字坐标,英语也返回单字母坐标

```python linenums="1"
from rapidocr_onnxruntime import RapidOCR
Expand Down

0 comments on commit ad1f46a

Please sign in to comment.