Skip to content

πŸ“„ Awesome OCR multiple programing languages toolkits based on ONNX Runtime, OpenVINO, MNN, PaddlePaddle, TensorRT and PyTorch.

chore: update files

SWHL246cb1c32146
diff --git a/docs/doc_whl_rapidocr.md b/docs/doc_whl_rapidocr.md
new file mode 100644
index 0000000..2eb5f86
--- /dev/null
+++ b/docs/doc_whl_rapidocr.md
@@ -0,0 +1 @@
+### See [Documentation](https://rapidai.github.io/RapidOCRDocs/install_usage/rapidocr/usage/)
diff --git a/python/rapidocr/main.py b/python/rapidocr/main.py
index b8f7740..e83fdf0 100644
--- a/python/rapidocr/main.py
+++ b/python/rapidocr/main.py
@@ -1,6 +1,7 @@
# -*- encoding: utf-8 -*-
# @Author: SWHL
# @Contact: [email protected]
+import argparse
import copy
from pathlib import Path
from typing import Any, Dict, List, Optional, Tuple, Union
@@ -15,12 +16,10 @@ from .ch_ppocr_rec import TextRecInput, TextRecognizer, TextRecOutput
from .inference_engine.base import get_engine_name
from .utils import (
LoadImage,
- Logger,
RapidOCROutput,
VisRes,
add_round_letterbox,
increase_min_side,
- init_args,
parse_lang,
reduce_max_side,
)
@@ -38,8 +37,6 @@ class RapidOCR:
config = ParseParams.load(config_path)
else:
config = ParseParams.load(DEFAULT_CFG_PATH)
- # config = ParseParams.update_model_path(config)
- # config = ParseParams.update_dict_path(config)
if params:
config = ParseParams.update_batch(config, params)
@@ -317,40 +314,50 @@ class RapidOCR:
ParseParams.save(self.config, f)
-def main():
- logger = Logger(logger_name=__name__).get_log()
+def parse_args(arg_list: Optional[List[str]] = None):
+ parser = argparse.ArgumentParser()
+ parser.add_argument("-img", "--img_path", type=str, default=None, required=True)
+ parser.add_argument("--text_score", type=float, default=0.5)
+ parser.add_argument("-vis", "--vis_res", action="store_true", default=False)
+ parser.add_argument("--vis_save_dir", type=Path, default=".")
+ parser.add_argument(
+ "-word", "--return_word_box", action="store_true", default=False
+ )
+ args = parser.parse_args(arg_list)
+ return args
- args = init_args()
- ocr_engine = RapidOCR(**vars(args))
- use_det = not args.no_det
- use_cls = not args.no_cls
- use_rec = not args.no_rec
- result, elapse_list = ocr_engine(
- args.img_path, use_det=use_det, use_cls=use_cls, use_rec=use_rec, **vars(args)
- )
- logger.info(result)
+def main(arg_list: Optional[List[str]] = None):
+ args = parse_args(arg_list)
+ params = {
+ "Global.text_score": args.text_score,
+ "Global.return_word_box": args.return_word_box,
+ }
+ ocr_engine = RapidOCR(params=params)
+
+ if args.return_word_box:
+ result = ocr_engine(args.img_path, return_word_box=args.return_word_box)
+ else:
+ result = ocr_engine(args.img_path)
+
+ print(result)
if args.vis_res:
vis = VisRes()
- Path(args.vis_save_path).mkdir(parents=True, exist_ok=True)
- save_path = Path(args.vis_save_path) / f"{Path(args.img_path).stem}_vis.png"
+ cur_dir = args.vis_save_dir
- if use_det and not use_cls and not use_rec:
- boxes, *_ = list(zip(*result))
- vis_img = vis(args.img_path, boxes)
+ if args.return_word_box:
+ words_results = result.word_results
+ words, words_scores, words_boxes = list(zip(*words_results))
+ vis_img = vis(args.img_path, words_boxes, words, words_scores)
+ save_path = cur_dir / f"{Path(args.img_path).stem}_vis_single.png"
cv2.imwrite(str(save_path), vis_img)
- logger.info("The vis result has saved in %s", save_path)
-
- elif use_det and use_rec:
- font_path = Path(args.vis_font_path)
- if not font_path.exists():
- raise FileExistsError(f"{font_path} does not exist!")
-
- boxes, txts, scores = list(zip(*result))
- vis_img = vis(args.img_path, boxes, txts, scores, font_path=font_path)
+ print("The vis single result has saved in %s", save_path)
+ else:
+ save_path = cur_dir / f"{Path(args.img_path).stem}_vis.png"
+ vis_img = vis(args.img_path, result.boxes, result.txts, result.scores)
cv2.imwrite(str(save_path), vis_img)
- logger.info("The vis result has saved in %s", save_path)
+ print("The vis result has saved in %s", save_path)
if __name__ == "__main__":
diff --git a/python/rapidocr/utils/__init__.py b/python/rapidocr/utils/__init__.py
index c69cb6c..3282700 100644
--- a/python/rapidocr/utils/__init__.py
+++ b/python/rapidocr/utils/__init__.py
@@ -3,7 +3,7 @@
# @Contact: [email protected]
from .load_image import LoadImage, LoadImageError
from .logger import Logger
-from .parse_parameters import ParseParams, init_args, parse_lang
+from .parse_parameters import ParseParams, parse_lang
from .process_img import add_round_letterbox, increase_min_side, reduce_max_side
from .typings import RapidOCROutput
from .utils import download_file
diff --git a/python/rapidocr/utils/parse_parameters.py b/python/rapidocr/utils/parse_parameters.py
index 2c10524..8bece79 100644
--- a/python/rapidocr/utils/parse_parameters.py
+++ b/python/rapidocr/utils/parse_parameters.py
@@ -1,7 +1,6 @@
# -*- encoding: utf-8 -*-
# @Author: SWHL
# @Contact: [email protected]
-import argparse
from pathlib import Path
from typing import Dict, Union
@@ -119,46 +118,8 @@ class ParseParams(OmegaConf):
def __init__(self):
pass
- @classmethod
- def update_model_path(cls, cfg: DictConfig) -> DictConfig:
- keys = ["model_path", "model_dir"]
- for key in keys:
- cls.update(cfg, f"Det.{key}", str(root_dir / cfg.Det[key]))
- cls.update(cfg, f"Cls.{key}", str(root_dir / cfg.Cls[key]))
- cls.update(cfg, f"Rec.{key}", str(root_dir / cfg.Rec[key]))
- return cfg
-
- @classmethod
- def update_dict_path(
- cls, cfg: DictConfig, key: str = "rec_keys_path"
- ) -> DictConfig:
- cls.update(cfg, f"Rec.{key}", str(root_dir / cfg.Rec[key]))
- return cfg
-
@classmethod
def update_batch(cls, cfg: DictConfig, params: Dict[str, str]) -> DictConfig:
for k, v in params.items():
cls.update(cfg, k, v)
return cfg
-
-
-def init_args():
- parser = argparse.ArgumentParser()
- parser.add_argument("-img", "--img_path", type=str, default=None, required=True)
- parser.add_argument("--text_score", type=float, default=0.5)
- parser.add_argument("-vis", "--vis_res", action="store_true", default=False)
- parser.add_argument(
- "--vis_font_path",
- type=str,
- default=None,
- help="When -vis is True, the font_path must have value.",
- )
- parser.add_argument(
- "--vis_save_path",
- type=str,
- default=".",
- help="The directory of saving the vis image.",
- )
-
- args = parser.parse_args()
- return args
diff --git a/python/rapidocr/utils/utils.py b/python/rapidocr/utils/utils.py
index fb301d6..5e44a7e 100644
--- a/python/rapidocr/utils/utils.py
+++ b/python/rapidocr/utils/utils.py
@@ -14,11 +14,15 @@ def download_file(url: str, save_path: Union[str, Path], logger=None):
if Path(save_path).exists():
if logger is not None:
- logger.info("Model already exists in %s", save_path)
+ logger.info("File already exists in %s", save_path)
+ else:
+ print(f"File already exists in {save_path}")
return
if logger is not None:
- logger.info("Downloading model from %s to %s", url, save_path)
+ logger.info("Downloading file from %s to %s", url, save_path)
+ else:
+ print(f"Downloading file from {url} to {save_path}")
response = requests.get(url, stream=True, timeout=60)
status_code = response.status_code
diff --git a/python/setup.py b/python/setup.py
index 2f7209d..6e691bc 100644
--- a/python/setup.py
+++ b/python/setup.py
@@ -17,7 +17,7 @@ def read_txt(txt_path: Union[Path, str]) -> List[str]:
def get_readme():
root_dir = Path(__file__).resolve().parent.parent
- readme_path = str(root_dir / "docs" / "doc_whl_rapidocr_ort.md")
+ readme_path = str(root_dir / "docs" / "doc_whl_rapidocr.md")
print(readme_path)
with open(readme_path, "r", encoding="utf-8") as f:
readme = f.read()
@@ -27,7 +27,10 @@ def get_readme():
MODULE_NAME = "rapidocr"
obtainer = GetPyPiLatestVersion()
-latest_version = obtainer(MODULE_NAME)
+try:
+ latest_version = obtainer(MODULE_NAME)
+except Exception as e:
+ latest_version = "0.0.0"
VERSION_NUM = obtainer.version_add_one(latest_version, add_patch=True)
if len(sys.argv) > 2:
diff --git a/python/tests/test_main.py b/python/tests/test_main.py
index 848123a..8029306 100644
--- a/python/tests/test_main.py
+++ b/python/tests/test_main.py
@@ -1,6 +1,7 @@
# -*- encoding: utf-8 -*-
# @Author: SWHL
# @Contact: [email protected]
+import shlex
import sys
from pathlib import Path
from typing import Any, Dict, List, Optional
@@ -13,6 +14,7 @@ root_dir = Path(__file__).resolve().parent.parent
sys.path.append(str(root_dir))
from rapidocr import LoadImageError, RapidOCR
+from rapidocr.main import main
from rapidocr.utils.logger import Logger
from rapidocr.utils.utils import download_file
@@ -36,6 +38,33 @@ def get_engine(params: Optional[Dict[str, Any]] = None):
return engine
[email protected]("cmd,gt", [(f"--img_path {img_path}", "正品促销")])
+def test_cli(capsys, cmd, gt):
+ main(shlex.split(cmd))
+ output = capsys.readouterr().out.strip()
+ assert gt in output
+
+
+ "cmd,img_name",
+ [
+ (
+ f"--img_path {img_path} -vis --vis_save_dir {tests_dir}",
+ f"{img_path.stem}_vis.png",
+ ),
+ (
+ f"--img_path {img_path} -vis --vis_save_dir {tests_dir} -word",
+ f"{img_path.stem}_vis_single.png",
+ ),
+ ],
+)
+def test_cli_vis(cmd, img_name):
+ main(shlex.split(cmd))
+ vis_path = tests_dir / img_name
+ assert vis_path.exists()
+ vis_path.unlink()
+
+
def test_error_lang():
with pytest.raises(ValueError) as exc_info:
engine = get_engine(params={"Global.lang": "eh"})