paddlex 3.0.0rc1__py3-none-any.whl → 3.0.1__py3-none-any.whl

paddlex/modules/text_detection/evaluator.py

@@ -23,14 +23,14 @@ class TextDetEvaluator(BaseEvaluator):
     entities = MODELS
 
     def update_config(self):
-        """update evalution config"""
+        """update evaluation config"""
         if self.eval_config.log_interval:
             self.pdx_config.update_log_interval(self.eval_config.log_interval)
 
         self.pdx_config.update_dataset(self.global_config.dataset_dir, "TextDetDataset")
 
     def get_eval_kwargs(self) -> dict:
-        """get key-value arguments of model evalution function
+        """get key-value arguments of model evaluation function
 
         Returns:
             dict: the arguments of evaluation function.

paddlex/modules/text_detection/model_list.py

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 MODELS = [
+    "PP-OCRv5_mobile_det",
+    "PP-OCRv5_server_det",
     "PP-OCRv4_mobile_det",
     "PP-OCRv4_server_det",
     "PP-OCRv4_mobile_seal_det",

paddlex/modules/text_recognition/evaluator.py

@@ -25,7 +25,7 @@ class TextRecEvaluator(BaseEvaluator):
     entities = MODELS
 
     def update_config(self):
-        """update evalution config"""
+        """update evaluation config"""
         if self.eval_config.log_interval:
             self.pdx_config.update_log_interval(self.eval_config.log_interval)
         if self.global_config["model"] == "LaTeX_OCR_rec":
@@ -53,7 +53,7 @@ class TextRecEvaluator(BaseEvaluator):
             self.pdx_config.update_label_dict_path(label_dict_path)
 
     def get_eval_kwargs(self) -> dict:
-        """get key-value arguments of model evalution function
+        """get key-value arguments of model evaluation function
 
         Returns:
             dict: the arguments of evaluation function.

paddlex/modules/text_recognition/model_list.py

@@ -31,4 +31,6 @@ MODELS = [
     "PP-OCRv4_server_rec_doc",
     "ch_SVTRv2_rec",
     "ch_RepSVTR_rec",
+    "PP-OCRv5_server_rec",
+    "PP-OCRv5_mobile_rec",
 ]

paddlex/modules/ts_anomaly_detection/evaluator.py

@@ -41,7 +41,7 @@ class TSADEvaluator(BaseEvaluator):
         return config_path
 
     def update_config(self):
-        """update evalution config"""
+        """update evaluation config"""
         self.pdx_config.update_dataset(self.global_config.dataset_dir, "TSADDataset")
         self.pdx_config.update_weights(self.eval_config.weight_path)
 
@@ -56,7 +56,7 @@ class TSADEvaluator(BaseEvaluator):
             )
 
     def get_eval_kwargs(self) -> dict:
-        """get key-value arguments of model evalution function
+        """get key-value arguments of model evaluation function
 
         Returns:
             dict: the arguments of evaluation function.

paddlex/modules/ts_classification/dataset_checker/dataset_src/split_dataset.py

@@ -55,7 +55,7 @@ def split_dataset(root_dir, train_rate, val_rate, group_id="group_id"):
     df = df.drop_duplicates(keep="first")
 
     group_unique = df[group_id].unique()
-    dfs = []  # seperate multiple group
+    dfs = []  # separate multiple group
     for column in group_unique:
         df_one = df[df[group_id].isin([column])]
         df_one = df_one.drop_duplicates(subset=["time"], keep="first")

paddlex/modules/ts_classification/evaluator.py

@@ -41,11 +41,11 @@ class TSCLSEvaluator(BaseEvaluator):
         return config_path
 
     def update_config(self):
-        """update evalution config"""
+        """update evaluation config"""
         self.pdx_config.update_dataset(self.global_config.dataset_dir, "TSCLSDataset")
 
     def get_eval_kwargs(self) -> dict:
-        """get key-value arguments of model evalution function
+        """get key-value arguments of model evaluation function
 
         Returns:
             dict: the arguments of evaluation function.

paddlex/modules/ts_forecast/evaluator.py

@@ -41,11 +41,11 @@ class TSFCEvaluator(BaseEvaluator):
         return config_path
 
     def update_config(self):
-        """update evalution config"""
+        """update evaluation config"""
         self.pdx_config.update_dataset(self.global_config.dataset_dir, "TSDataset")
 
     def get_eval_kwargs(self) -> dict:
-        """get key-value arguments of model evalution function
+        """get key-value arguments of model evaluation function
 
         Returns:
             dict: the arguments of evaluation function.

paddlex/modules/video_classification/evaluator.py

@@ -22,7 +22,7 @@ class VideoClsEvaluator(BaseEvaluator):
     entities = MODELS
 
     def update_config(self):
-        """update evalution config"""
+        """update evaluation config"""
         if self.eval_config.log_interval:
             self.pdx_config.update_log_interval(self.eval_config.log_interval)
         self.pdx_config.update_dataset(
@@ -33,7 +33,7 @@ class VideoClsEvaluator(BaseEvaluator):
         self.pdx_config.update_pretrained_weights(self.eval_config.weight_path)
 
     def get_eval_kwargs(self) -> dict:
-        """get key-value arguments of model evalution function
+        """get key-value arguments of model evaluation function
 
         Returns:
             dict: the arguments of evaluation function.

paddlex/modules/video_detection/evaluator.py

@@ -22,7 +22,7 @@ class VideoDetEvaluator(BaseEvaluator):
     entities = MODELS
 
     def update_config(self):
-        """update evalution config"""
+        """update evaluation config"""
         if self.eval_config.log_interval:
             self.pdx_config.update_log_interval(self.eval_config.log_interval)
         self.pdx_config.update_dataset(
@@ -31,7 +31,7 @@ class VideoDetEvaluator(BaseEvaluator):
         self.pdx_config.update_pretrained_weights(self.eval_config.weight_path)
 
     def get_eval_kwargs(self) -> dict:
-        """get key-value arguments of model evalution function
+        """get key-value arguments of model evaluation function
 
         Returns:
             dict: the arguments of evaluation function.

paddlex/ops/__init__.py

@@ -114,7 +114,7 @@ class PaddleXCustomOperatorModule(ModuleType):
             with filelock.FileLock(lockfile):
                 return paddle_jit_load(name=self.modulename, sources=sources, **args)
         except:
-            logging.error("{} builded fail!".format(self.modulename))
+            logging.error("{} built fail!".format(self.modulename))
             raise
 
     def _load_module(self):
@@ -126,7 +126,7 @@ class PaddleXCustomOperatorModule(ModuleType):
                     "No custom op {} found, try JIT build".format(self.modulename)
                 )
                 self.module = self.jit_build()
-                logging.info("{} builded success!".format(self.modulename))
+                logging.info("{} built success!".format(self.modulename))
 
             # refresh
             sys.modules[self.fullname] = self.module

paddlex/paddlex_cli.py

@@ -66,15 +66,9 @@ def args_cfg():
     ################# install pdx #################
     install_group.add_argument(
         "--install",
-        action="store_true",
-        default=False,
-        help="Install specified PaddleX plugins.",
-    )
-    install_group.add_argument(
-        "plugins",
         nargs="*",
-        default=[],
-        help="Names of custom development plugins to install (space-separated).",
+        metavar="PLUGIN",
+        help="Install specified PaddleX plugins.",
     )
     install_group.add_argument(
         "--no_deps",
@@ -193,7 +187,10 @@ def args_cfg():
     pipeline = args.pipeline
     pipeline_args = []
 
-    if not (args.install or args.serve or args.paddle2onnx) and pipeline is not None:
+    if (
+        not (args.install is not None or args.serve or args.paddle2onnx)
+        and pipeline is not None
+    ):
         if os.path.isfile(pipeline):
             pipeline_name = load_pipeline_config(pipeline)["pipeline_name"]
         else:
@@ -247,7 +244,12 @@ def install(args):
         if device_type == "cpu":
             package = "ultra-infer-python"
         elif device_type == "gpu":
-            if get_paddle_cuda_version()[0] != 11:
+            cuda_version = get_paddle_cuda_version()
+            if not cuda_version:
+                sys.exit(
+                    "No CUDA version found. Please make sure you have installed PaddlePaddle with CUDA enabled."
+                )
+            if cuda_version[0] != 11:
                 sys.exit(
                     "You are not using PaddlePaddle compiled with CUDA 11. Currently, CUDA versions other than 11.x are not supported by the high-performance inference plugin."
                 )
@@ -263,7 +265,7 @@ def install(args):
     # Disable eager initialization
     os.environ["PADDLE_PDX_EAGER_INIT"] = "False"
 
-    plugins = args.plugins[:]
+    plugins = args.install[:]
 
     if "serving" in plugins:
         plugins.remove("serving")
@@ -435,8 +437,9 @@ def main():
         parser.print_help()
         sys.exit(2)
 
-    if args.install:
+    if args.install is not None:
         install(args)
+        return
     elif args.serve:
         serve(
             args.pipeline,
@@ -446,12 +449,14 @@ def main():
             host=args.host,
             port=args.port,
         )
+        return
     elif args.paddle2onnx:
         paddle_to_onnx(
             args.paddle_model_dir,
             args.onnx_model_dir,
             opset_version=args.opset_version,
         )
+        return
     else:
         if args.get_pipeline_config is not None:
             interactive_get_pipeline(args.get_pipeline_config, args.save_path)
@@ -464,7 +469,7 @@ def main():
                     pipeline_args_dict[arg_name] = getattr(args, arg_name)
                 else:
                     logging.warning(f"Argument {arg_name} is missing in args")
-            return pipeline_predict(
+            pipeline_predict(
                 args.pipeline,
                 args.input,
                 args.device,
@@ -473,3 +478,4 @@ def main():
                 hpi_config=args.hpi_config,
                 **pipeline_args_dict,
             )
+            return

paddlex/repo_apis/Paddle3D_api/bev_fusion/model.py

@@ -54,7 +54,7 @@ class BEVFusionModel(BaseModel):
             raise ValueError(f"`dy2st`={dy2st} is not supported.")
         if device in ("cpu", "gpu"):
             logging.warning(
-                f"The device type to use will be automatically determined, which may differ from the sepcified type: {repr(device)}."
+                f"The device type to use will be automatically determined, which may differ from the specified type: {repr(device)}."
             )
 
         # Update YAML config file
@@ -134,7 +134,7 @@ class BEVFusionModel(BaseModel):
 
         if device in ("cpu", "gpu"):
             logging.warning(
-                f"The device type to use will be automatically determined, which may differ from the sepcified type: {repr(device)}."
+                f"The device type to use will be automatically determined, which may differ from the specified type: {repr(device)}."
             )
 
         # Update YAML config file

paddlex/repo_apis/PaddleClas_api/cls/config.py

@@ -464,7 +464,7 @@ indicating that no pretrained model to be used."
         """update directory that save predicting output
 
         Args:
-            save_dir (str): the dicrectory path that save predicting output.
+            save_dir (str): the directory path that save predicting output.
         """
         self.update([f"Infer.save_dir={save_dir}"])
 

paddlex/repo_apis/PaddleClas_api/cls/model.py

@@ -265,7 +265,7 @@ class ClsModel(BaseModel):
             dict_path (str, optional): the label dict file path. Defaults to None.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         model_dir = abspath(model_dir)
         input_path = abspath(input_path)

paddlex/repo_apis/PaddleClas_api/cls/register.py

@@ -896,6 +896,16 @@ register_model_info(
     }
 )
 
+register_model_info(
+    {
+        "model_name": "PP-LCNet_x1_0_textline_ori",
+        "suite": "Cls",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-LCNet_x1_0_textline_ori.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export", "infer"],
+        "infer_config": "deploy/configs/inference_cls.yaml",
+    }
+)
+
 register_model_info(
     {
         "model_name": "PP-LCNet_x1_0_table_cls",

paddlex/repo_apis/PaddleClas_api/cls/runner.py

@@ -135,7 +135,7 @@ class ClsRunner(BaseRunner):
             device (str): unused.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         # `device` unused
         cmd = [self.python, "python/predict_cls.py", "-c", config_path, *cli_args]

paddlex/repo_apis/PaddleDetection_api/instance_seg/model.py

@@ -310,7 +310,7 @@ class InstanceSegModel(BaseModel):
             save_dir (str, optional): the directory path to save output. Defaults to None.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         model_dir = abspath(model_dir)
         input_path = abspath(input_path)

paddlex/repo_apis/PaddleDetection_api/instance_seg/runner.py

@@ -138,7 +138,7 @@ class InstanceSegRunner(BaseRunner):
             device (str): unused.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         # `device` unused
         cmd = [self.python, "deploy/python/infer.py", "--use_fd_format", *cli_args]

paddlex/repo_apis/PaddleDetection_api/object_det/config.py

@@ -423,7 +423,7 @@ class DetConfig(BaseConfig, PPDetConfigMixin):
 
         Args:
             config (dict): the original config.
-            update_dict (dict): to be updated paramenters and its values
+            update_dict (dict): to be updated parameters and its values
 
         Example:
             self._recursively_set(self.HybridEncoder, {'encoder_layer': {'dim_feedforward': 2048}})

paddlex/repo_apis/PaddleDetection_api/object_det/model.py

@@ -335,7 +335,7 @@ class DetModel(BaseModel):
             save_dir (str, optional): the directory path to save output. Defaults to None.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         model_dir = abspath(model_dir)
         input_path = abspath(input_path)

paddlex/repo_apis/PaddleDetection_api/object_det/official_categories.py

@@ -217,4 +217,29 @@ official_categories = {
         {"name": "footer_image", "id": 21},
         {"name": "aside_text", "id": 22},
     ],
+    "PP-DocLayout_plus-L": [
+        {"name": "paragraph_title", "id": 0},
+        {"name": "image", "id": 1},
+        {"name": "text", "id": 2},
+        {"name": "number", "id": 3},
+        {"name": "abstract", "id": 4},
+        {"name": "content", "id": 5},
+        {"name": "figure_title", "id": 6},
+        {"name": "formula", "id": 7},
+        {"name": "table", "id": 8},
+        {"name": "reference", "id": 9},
+        {"name": "doc_title", "id": 10},
+        {"name": "footnote", "id": 11},
+        {"name": "header", "id": 12},
+        {"name": "algorithm", "id": 13},
+        {"name": "footer", "id": 14},
+        {"name": "seal", "id": 15},
+        {"name": "chart", "id": 16},
+        {"name": "formula_number", "id": 17},
+        {"name": "aside_text", "id": 18},
+        {"name": "reference_content", "id": 19},
+    ],
+    "PP-DocBlockLayout": [
+        {"name": "Region", "id": 0},
+    ],
 }

paddlex/repo_apis/PaddleDetection_api/object_det/register.py

@@ -1103,3 +1103,33 @@ register_model_info(
         },
     }
 )
+
+register_model_info(
+    {
+        "model_name": "PP-DocLayout_plus-L",
+        "suite": "Det",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-DocLayout_plus-L.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export", "infer"],
+        "supported_dataset_types": ["COCODetDataset"],
+        "supported_train_opts": {
+            "device": ["cpu", "gpu_nxcx", "xpu", "npu", "mlu"],
+            "dy2st": False,
+            "amp": ["OFF"],
+        },
+    }
+)
+
+register_model_info(
+    {
+        "model_name": "PP-DocBlockLayout",
+        "suite": "Det",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-DocBlockLayout.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export", "infer"],
+        "supported_dataset_types": ["COCODetDataset"],
+        "supported_train_opts": {
+            "device": ["cpu", "gpu_nxcx", "xpu", "npu", "mlu"],
+            "dy2st": False,
+            "amp": ["OFF"],
+        },
+    }
+)

paddlex/repo_apis/PaddleDetection_api/object_det/runner.py

@@ -138,7 +138,7 @@ class DetRunner(BaseRunner):
             device (str): unused.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         # `device` unused
         cmd = [self.python, "deploy/python/infer.py", "--use_fd_format", *cli_args]

paddlex/repo_apis/PaddleOCR_api/formula_rec/config.py

@@ -420,11 +420,11 @@ class FormulaRecConfig(BaseConfig):
         self._update_save_interval(save_interval)
 
     def _update_infer_img(self, infer_img: str, infer_list: str = None):
-        """update image list to be infered
+        """update image list to be inferred
 
         Args:
-            infer_img (str): path to the image file to be infered. It would be ignored when `infer_list` is be set.
-            infer_list (str, optional): path to the .txt file containing the paths to image to be infered.
+            infer_img (str): path to the image file to be inferred. It would be ignored when `infer_list` is be set.
+            infer_list (str, optional): path to the .txt file containing the paths to image to be inferred.
                 Defaults to None.
         """
         if infer_list:

paddlex/repo_apis/PaddleOCR_api/formula_rec/model.py

@@ -135,11 +135,9 @@ class FormulaRecModel(BaseModel):
         # PDX related settings
         device_type = device.split(":")[0]
         uniform_output_enabled = kwargs.pop("uniform_output_enabled", True)
-        export_with_pir = kwargs.pop("export_with_pir", False)
         config.update({"Global.uniform_output_enabled": uniform_output_enabled})
-        config.update({"Global.pdx_model_name": self.name})
-        if export_with_pir:
-            config.update({"Global.export_with_pir": export_with_pir})
+        config.update({"Global.model_name": self.name})
+        config.update({"Global.export_with_pir": kwargs.pop("export_with_pir", False)})
 
         self._assert_empty_kwargs(kwargs)
 
@@ -272,11 +270,9 @@ class FormulaRecModel(BaseModel):
 
         # PDX related settings
         uniform_output_enabled = kwargs.pop("uniform_output_enabled", True)
-        export_with_pir = kwargs.pop("export_with_pir", False)
         config.update({"Global.uniform_output_enabled": uniform_output_enabled})
-        config.update({"Global.pdx_model_name": self.name})
-        if export_with_pir:
-            config.update({"Global.export_with_pir": export_with_pir})
+        config.update({"Global.model_name": self.name})
+        config.update({"Global.export_with_pir": kwargs.pop("export_with_pir", False)})
 
         self._assert_empty_kwargs(kwargs)
 
@@ -301,7 +297,7 @@ class FormulaRecModel(BaseModel):
             save_dir (str, optional): the directory path to save output. Defaults to None.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         config = self.config.copy()
         cli_args = []

paddlex/repo_apis/PaddleOCR_api/formula_rec/register.py

@@ -70,3 +70,30 @@ register_model_info(
         "supported_apis": ["train", "evaluate", "predict", "export", "infer"],
     }
 )
+
+register_model_info(
+    {
+        "model_name": "PP-FormulaNet_plus-S",
+        "suite": "FormulaRec",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-FormulaNet_plus-S.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export", "infer"],
+    }
+)
+
+register_model_info(
+    {
+        "model_name": "PP-FormulaNet_plus-M",
+        "suite": "FormulaRec",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-FormulaNet_plus-M.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export", "infer"],
+    }
+)
+
+register_model_info(
+    {
+        "model_name": "PP-FormulaNet_plus-L",
+        "suite": "FormulaRec",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-FormulaNet_plus-L.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export", "infer"],
+    }
+)

paddlex/repo_apis/PaddleOCR_api/formula_rec/runner.py

@@ -131,7 +131,7 @@ class FormulaRecRunner(BaseRunner):
             device (str): unused.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         cmd = [self.python, "tools/infer/predict_rec.py", *cli_args]
         return self.run_cmd(cmd, switch_wdir=True, echo=True, silent=False)

paddlex/repo_apis/PaddleOCR_api/table_rec/model.py

@@ -85,7 +85,7 @@ class TableRecModel(TextRecModel):
             save_dir (str, optional): the directory path to save output. Defaults to None.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         config = self.config.copy()
         cli_args = []

paddlex/repo_apis/PaddleOCR_api/table_rec/runner.py

@@ -45,7 +45,7 @@ class TableRecRunner(TextRecRunner):
             device (str): unused.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         cmd = [self.python, "ppstructure/table/predict_structure.py", *cli_args]
         return self.run_cmd(cmd, switch_wdir=True, echo=True, silent=False)

paddlex/repo_apis/PaddleOCR_api/text_det/model.py

@@ -41,7 +41,7 @@ class TextDetModel(TextRecModel):
             save_dir (str, optional): the directory path to save output. Defaults to None.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         config = self.config.copy()
         cli_args = []

paddlex/repo_apis/PaddleOCR_api/text_det/register.py

@@ -87,3 +87,21 @@ register_model_info(
         "supported_apis": ["train", "evaluate", "predict", "export"],
     }
 )
+
+register_model_info(
+    {
+        "model_name": "PP-OCRv5_server_det",
+        "suite": "TextDet",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-OCRv5_server_det.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export"],
+    }
+)
+
+register_model_info(
+    {
+        "model_name": "PP-OCRv5_mobile_det",
+        "suite": "TextDet",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-OCRv5_mobile_det.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export"],
+    }
+)

paddlex/repo_apis/PaddleOCR_api/text_det/runner.py

@@ -46,7 +46,7 @@ class TextDetRunner(TextRecRunner):
             device (str): unused.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         # `config_path` and `device` unused
         cmd = [self.python, "tools/infer/predict_det.py", *cli_args]

paddlex/repo_apis/PaddleOCR_api/text_rec/config.py

@@ -413,11 +413,11 @@ class TextRecConfig(BaseConfig):
         self._update_save_interval(save_interval)
 
     def _update_infer_img(self, infer_img: str, infer_list: str = None):
-        """update image list to be infered
+        """update image list to be inferred
 
         Args:
-            infer_img (str): path to the image file to be infered. It would be ignored when `infer_list` is be set.
-            infer_list (str, optional): path to the .txt file containing the paths to image to be infered.
+            infer_img (str): path to the image file to be inferred. It would be ignored when `infer_list` is be set.
+            infer_list (str, optional): path to the .txt file containing the paths to image to be inferred.
                 Defaults to None.
         """
         if infer_list: