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

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:

paddlex/repo_apis/PaddleOCR_api/text_rec/model.py

@@ -135,11 +135,9 @@ class TextRecModel(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 TextRecModel(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 TextRecModel(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/text_rec/register.py

@@ -196,3 +196,21 @@ register_model_info(
         "supported_apis": ["train", "evaluate", "predict", "export", "infer"],
     }
 )
+
+register_model_info(
+    {
+        "model_name": "PP-OCRv5_server_rec",
+        "suite": "TextRec",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-OCRv5_server_rec.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export"],
+    }
+)
+
+register_model_info(
+    {
+        "model_name": "PP-OCRv5_mobile_rec",
+        "suite": "TextRec",
+        "config_path": osp.join(PDX_CONFIG_DIR, "PP-OCRv5_mobile_rec.yaml"),
+        "supported_apis": ["train", "evaluate", "predict", "export"],
+    }
+)

paddlex/repo_apis/PaddleOCR_api/text_rec/runner.py

@@ -131,7 +131,7 @@ class TextRecRunner(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/PaddleSeg_api/seg/model.py

@@ -388,7 +388,7 @@ class SegModel(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/PaddleSeg_api/seg/runner.py

@@ -151,7 +151,7 @@ class SegRunner(BaseRunner):
             device (str): unused.
 
         Returns:
-            CompletedProcess: the result of infering subprocess execution.
+            CompletedProcess: the result of inferring subprocess execution.
         """
         # `device` unused
         cli_args = self._gather_opts_args(cli_args)

paddlex/repo_apis/PaddleTS_api/ts_ad/config.py

@@ -24,7 +24,7 @@ class TSAnomalyConfig(BaseTSConfig):
 
     def update_input_len(self, seq_len: int):
         """
-        upadte the input sequence length
+        update the input sequence length
 
         Args:
             seq_len (int): input length
@@ -40,7 +40,7 @@ class TSAnomalyConfig(BaseTSConfig):
 
     def update_dataset(self, dataset_dir: str, dataset_type: str = None):
         """
-        upadte the dataset
+        update the dataset
 
         Args:
             dataset_dir (str): dataset root path
@@ -57,7 +57,7 @@ class TSAnomalyConfig(BaseTSConfig):
         update basic info including time_col, freq, target_cols.
 
         Args:
-            info_params (dict): upadte basic info
+            info_params (dict): update basic info
 
         Raises:
             TypeError: if info_params is not dict, raising TypeError

paddlex/repo_apis/PaddleTS_api/ts_cls/config.py

@@ -24,7 +24,7 @@ class TSClassifyConfig(BaseTSConfig):
 
     def update_dataset(self, dataset_dir: str, dataset_type: str = None):
         """
-        upadte the dataset
+        update the dataset
 
         Args:
             dataset_dir (str): dataset root path
@@ -41,7 +41,7 @@ class TSClassifyConfig(BaseTSConfig):
         update basic info including time_col, freq, target_cols.
 
         Args:
-            info_params (dict): upadte basic info
+            info_params (dict): update basic info
 
         Raises:
             TypeError: if info_params is not dict, raising TypeError

paddlex/repo_apis/PaddleTS_api/ts_fc/config.py

@@ -24,7 +24,7 @@ class LongForecastConfig(BaseTSConfig):
 
     def update_input_len(self, seq_len: int):
         """
-        upadte the input sequence length
+        update the input sequence length
 
         Args:
             seq_len (int): input length
@@ -72,7 +72,7 @@ class LongForecastConfig(BaseTSConfig):
 
     def update_dataset(self, dataset_dir: str, dataset_type: str = None):
         """
-        upadte the dataset
+        update the dataset
 
         Args:
             dataset_dir (str): dataset root path
@@ -89,7 +89,7 @@ class LongForecastConfig(BaseTSConfig):
         update basic info including time_col, freq, target_cols.
 
         Args:
-            info_params (dict): upadte basic info
+            info_params (dict): update basic info
 
         Raises:
             TypeError: if info_params is not dict, raising TypeError
@@ -104,7 +104,7 @@ class LongForecastConfig(BaseTSConfig):
         update patience.
 
         Args:
-            patience (int): upadte patience
+            patience (int): update patience
 
         Raises:
             RuntimeError: if patience is not found, raising RuntimeError

paddlex/repo_apis/PaddleVideo_api/video_cls/config.py

@@ -435,7 +435,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({"Infer.save_dir": save_dir})
 

paddlex/repo_apis/PaddleVideo_api/video_cls/model.py

@@ -257,7 +257,7 @@ class VideoClsModel(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/PaddleVideo_api/video_cls/runner.py

@@ -136,7 +136,7 @@ class VideoClsRunner(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/PaddleVideo_api/video_det/config.py

@@ -436,7 +436,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({"Infer.save_dir": save_dir})
 

paddlex/repo_apis/PaddleVideo_api/video_det/model.py

@@ -258,7 +258,7 @@ class VideoDetModel(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/PaddleVideo_api/video_det/runner.py

@@ -136,7 +136,7 @@ class VideoDetRunner(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/base/config.py

@@ -106,7 +106,7 @@ class BaseConfig(_Config, metaclass=abc.ABCMeta):
     """
     Abstract base class of Config.
 
-    Config provides the funtionality to load, parse, or dump to a configuration
+    Config provides the functionality to load, parse, or dump to a configuration
     file with a specific format. Also, it provides APIs to update configurations
     of several important hyperparameters and model components.
     """

paddlex/repo_manager/core.py

@@ -101,7 +101,7 @@ def setup(
     """setup"""
     if update_repos and use_local_repos:
         logging.error(
-            f"The `--update_repos` and `--use_local_repos` should not be True at the same time. They are global setting for all repos. `--update_repos` means that update all repos to sync with remote, and `--use_local_repos` means that don't update when local repo is exsting."
+            f"The `--update_repos` and `--use_local_repos` should not be True at the same time. They are global setting for all repos. `--update_repos` means that update all repos to sync with remote, and `--use_local_repos` means that don't update when local repo is existing."
         )
         raise Exception()
 
@@ -136,7 +136,7 @@ def setup(
                 except EOFError:
                     logging.warning(
                         "Unable to read from stdin. Please set `--use_local_repos` to \
-                        True or False to apply a global setting for using exsting or re-getting repos."
+                        True or False to apply a global setting for using existing or re-getting repos."
                     )
                     raise
                 remove_existing = remove_existing.lower() in ("y", "yes")
@@ -174,7 +174,7 @@ def setup(
                 uninstall_existing = uninstall_existing.lower() in ("y", "yes")
 
             if uninstall_existing:
-                repo.uninstall()
+                build_repo_group_installer(repo).uninstall()
                 repos_to_install.append(repo)
             else:
                 logging.warning(

paddlex/repo_manager/meta.py

@@ -69,12 +69,12 @@ REPO_META = {
     "PaddleOCR": {
         "git_path": "/PaddlePaddle/PaddleOCR.git",
         "platform": "github",
-        "branch": "release/2.10",
+        "branch": "main",
         "install_pkg": False,
         "pdx_pkg_name": "PaddleOCR_api",
         "extra_pkgs": [
             "ppstructure/kie/requirements.txt",
-            "docs/algorithm/formula_recognition/requirements.txt",
+            "docs/version2.x/algorithm/formula_recognition/requirements.txt",
         ],
         "path_env": "PADDLE_PDX_PADDLEOCR_PATH",
         "requires": ["PaddleNLP"],
@@ -165,6 +165,10 @@ REPO_META = {
     },
 }
 
+REPO_DIST_NAMES = {
+    item["dist_name"] for item in REPO_META.values() if "dist_name" in item
+}
+
 
 def get_repo_meta(repo_name):
     """get_repo_meta"""