chore: fix typo

RapidAI · Jan 1, 2025 · df60847 · df60847
1 parent ad1f46a
commit df60847
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 25 deletions.
diff --git a/docs/install_usage/rapidocr/cli.md b/docs/install_usage/rapidocr/cli.md
@@ -8,30 +8,25 @@ comments: true
 
 ```bash linenums="1"
 $ rapidocr_onnxruntime -h
-usage: rapidocr_onnxruntime [-h] -img IMG_PATH [-p] [--text_score TEXT_SCORE]
-                            [--no_det] [--no_cls] [--no_rec] [--print_verbose]
-                            [--min_height MIN_HEIGHT]
+usage: rapidocr_onnxruntime [-h] -img IMG_PATH [-p] [--text_score TEXT_SCORE] [--no_det]
+                            [--no_cls] [--no_rec] [--print_verbose] [--min_height MIN_HEIGHT]
                             [--width_height_ratio WIDTH_HEIGHT_RATIO]
-                            [--det_use_cuda] [--det_model_path DET_MODEL_PATH]
-                            [--det_limit_side_len DET_LIMIT_SIDE_LEN]
-                            [--det_limit_type {max,min}]
-                            [--det_thresh DET_THRESH]
-                            [--det_box_thresh DET_BOX_THRESH]
-                            [--det_unclip_ratio DET_UNCLIP_RATIO]
-                            [--det_donot_use_dilation]
-                            [--det_score_mode {slow,fast}] [--cls_use_cuda]
-                            [--cls_model_path CLS_MODEL_PATH]
-                            [--cls_image_shape CLS_IMAGE_SHAPE]
-                            [--cls_label_list CLS_LABEL_LIST]
-                            [--cls_batch_num CLS_BATCH_NUM]
-                            [--cls_thresh CLS_THRESH] [--rec_use_cuda]
-                            [--rec_model_path REC_MODEL_PATH]
-                            [--rec_img_shape REC_IMG_SHAPE]
-                            [--rec_batch_num REC_BATCH_NUM] [-vis]
-                            [--vis_font_path VIS_FONT_PATH]
-                            [--vis_save_path VIS_SAVE_PATH]
-
-optional arguments:
+                            [--max_side_len MAX_SIDE_LEN] [--min_side_len MIN_SIDE_LEN]
+                            [--return_word_box] [--intra_op_num_threads INTRA_OP_NUM_THREADS]
+                            [--inter_op_num_threads INTER_OP_NUM_THREADS] [--det_use_cuda]
+                            [--det_use_dml] [--det_model_path DET_MODEL_PATH]
+                            [--det_limit_side_len DET_LIMIT_SIDE_LEN] [--det_limit_type {max,min}]
+                            [--det_thresh DET_THRESH] [--det_box_thresh DET_BOX_THRESH]
+                            [--det_unclip_ratio DET_UNCLIP_RATIO] [--det_donot_use_dilation]
+                            [--det_score_mode {slow,fast}] [--cls_use_cuda] [--cls_use_dml]
+                            [--cls_model_path CLS_MODEL_PATH] [--cls_image_shape CLS_IMAGE_SHAPE]
+                            [--cls_label_list CLS_LABEL_LIST] [--cls_batch_num CLS_BATCH_NUM]
+                            [--cls_thresh CLS_THRESH] [--rec_use_cuda] [--rec_use_dml]
+                            [--rec_model_path REC_MODEL_PATH] [--rec_keys_path REC_KEYS_PATH]
+                            [--rec_img_shape REC_IMG_SHAPE] [--rec_batch_num REC_BATCH_NUM] [-vis]
+                            [--vis_font_path VIS_FONT_PATH] [--vis_save_path VIS_SAVE_PATH]
+
+options:
   -h, --help            show this help message and exit
   -img IMG_PATH, --img_path IMG_PATH
   -p, --print_cost
@@ -44,9 +39,15 @@ Global:
   --print_verbose
   --min_height MIN_HEIGHT
   --width_height_ratio WIDTH_HEIGHT_RATIO
+  --max_side_len MAX_SIDE_LEN
+  --min_side_len MIN_SIDE_LEN
+  --return_word_box
+  --intra_op_num_threads INTRA_OP_NUM_THREADS
+  --inter_op_num_threads INTER_OP_NUM_THREADS
 
 Det:
   --det_use_cuda
+  --det_use_dml
   --det_model_path DET_MODEL_PATH
   --det_limit_side_len DET_LIMIT_SIDE_LEN
   --det_limit_type {max,min}
@@ -58,6 +59,7 @@ Det:
 
 Cls:
   --cls_use_cuda
+  --cls_use_dml
   --cls_model_path CLS_MODEL_PATH
   --cls_image_shape CLS_IMAGE_SHAPE
   --cls_label_list CLS_LABEL_LIST
@@ -66,7 +68,9 @@ Cls:
 
 Rec:
   --rec_use_cuda
+  --rec_use_dml
   --rec_model_path REC_MODEL_PATH
+  --rec_keys_path REC_KEYS_PATH
   --rec_img_shape REC_IMG_SHAPE
   --rec_batch_num REC_BATCH_NUM
 
@@ -105,5 +109,5 @@ Visual Result:
 === "可视化查看"
 
     ```bash linenums="1"
-    raprapidocr_onnxruntime -img tests/test_files/ch_en_num.jpg -vis --vis_font_path resources/fonts/FZYTK.TTF
+    rapidocr_onnxruntime -img tests/test_files/ch_en_num.jpg -vis --vis_font_path resources/fonts/FZYTK.TTF
     ```
diff --git a/docs/install_usage/rapidocr_api/usage.md b/docs/install_usage/rapidocr_api/usage.md
@@ -153,7 +153,7 @@ curl -F [email protected] http://0.0.0.0:9003/ocr
 
 如果图像中存在文字，则会输出字典格式，具体介绍如下：
 
-    ```python linenums="1"
+    ```json linenums="1"
     {
     "0": {
         "rec_txt": "香港深圳抽血，",  # 识别的文本