paddlex 2.1.0__py3-none-any.whl → 3.0.0b2__py3-none-any.whl

paddlex/modules/ts_forecast/trainer.py

@@ -0,0 +1,92 @@
+# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import json
+import time
+import tarfile
+from pathlib import Path
+
+from ..base import BaseTrainer
+from ...utils.config import AttrDict
+from .model_list import MODELS
+
+
+class TSFCTrainer(BaseTrainer):
+    """TS Forecast Model Trainer"""
+
+    entities = MODELS
+
+    def train(self):
+        """firstly, update and dump train config, then train model"""
+        # XXX: using super().train() instead when the train_hook() is supported.
+        os.makedirs(self.global_config.output, exist_ok=True)
+        self.update_config()
+        self.dump_config()
+        train_result = self.pdx_model.train(**self.get_train_kwargs())
+        assert (
+            train_result.returncode == 0
+        ), f"Encountered an unexpected error({train_result.returncode}) in \
+training!"
+
+        self.make_tar_file()
+
+    def make_tar_file(self):
+        """make tar file to package the training outputs"""
+        tar_path = Path(self.global_config.output) / "best_accuracy.pdparams.tar"
+        with tarfile.open(tar_path, "w") as tar:
+            tar.add(self.global_config.output, arcname="best_accuracy.pdparams")
+
+    def update_config(self):
+        """update training config"""
+        self.pdx_config.update_dataset(self.global_config.dataset_dir, "TSDataset")
+        if self.train_config.input_len is not None:
+            self.pdx_config.update_input_len(self.train_config.input_len)
+        if self.train_config.time_col is not None:
+            self.pdx_config.update_basic_info({"time_col": self.train_config.time_col})
+        if self.train_config.target_cols is not None:
+            self.pdx_config.update_basic_info(
+                {"target_cols": self.train_config.target_cols.split(",")}
+            )
+        if self.train_config.freq is not None:
+            try:
+                self.train_config.freq = int(self.train_config.freq)
+            except ValueError:
+                pass
+            self.pdx_config.update_basic_info({"freq": self.train_config.freq})
+        if self.train_config.predict_len is not None:
+            self.pdx_config.update_predict_len(self.train_config.predict_len)
+        if self.train_config.patience is not None:
+            self.pdx_config.update_patience(self.train_config.patience)
+        if self.train_config.batch_size is not None:
+            self.pdx_config.update_batch_size(self.train_config.batch_size)
+        if self.train_config.learning_rate is not None:
+            self.pdx_config.update_learning_rate(self.train_config.learning_rate)
+        if self.train_config.epochs_iters is not None:
+            self.pdx_config.update_epochs(self.train_config.epochs_iters)
+        if self.train_config.log_interval is not None:
+            self.pdx_config.update_log_interval(self.train_config.log_interval)
+        if self.global_config.output is not None:
+            self.pdx_config.update_save_dir(self.global_config.output)
+
+    def get_train_kwargs(self) -> dict:
+        """get key-value arguments of model training function
+
+        Returns:
+            dict: the arguments of training function.
+        """
+        train_args = {"device": self.get_device(using_device_number=1)}
+        if self.global_config.output is not None:
+            train_args["save_dir"] = self.global_config.output
+        return train_args

paddlex/paddlex_cli.py

@@ -0,0 +1,197 @@
+# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import argparse
+import subprocess
+import sys
+import tempfile
+
+from . import create_pipeline
+from .inference.pipelines import create_pipeline_from_config, load_pipeline_config
+from .repo_manager import setup, get_all_supported_repo_names
+from .utils import logging
+from .utils.interactive_get_pipeline import interactive_get_pipeline
+
+
+def _install_serving_deps():
+    SERVING_DEPS = [
+        "aiohttp>=3.9",
+        "bce-python-sdk>=0.8",
+        "fastapi>=0.110",
+        "pydantic>=2",
+        "starlette>=0.36",
+        "typing_extensions>=4.11",
+        "uvicorn>=0.16",
+        "yarl>=1.9",
+    ]
+    with tempfile.TemporaryDirectory() as td:
+        req_file = os.path.join(td, "requirements.txt")
+        with open(req_file, "w", encoding="utf-8") as f:
+            for dep in SERVING_DEPS:
+                f.write(dep + "\n")
+            f.flush()
+        return subprocess.check_call(
+            [sys.executable, "-m", "pip", "install", "-r", req_file]
+        )
+
+
+def args_cfg():
+    """parse cli arguments"""
+
+    def parse_str(s):
+        """convert str type value
+        to None type if it is "None",
+        to bool type if it means True or False.
+        """
+        if s in ("None"):
+            return None
+        elif s in ("TRUE", "True", "true", "T", "t"):
+            return True
+        elif s in ("FALSE", "False", "false", "F", "f"):
+            return False
+        return s
+
+    parser = argparse.ArgumentParser()
+
+    ################# install pdx #################
+    parser.add_argument("--install", action="store_true", default=False, help="")
+    parser.add_argument("plugins", nargs="*", default=[])
+    parser.add_argument("--no_deps", action="store_true")
+    parser.add_argument("--platform", type=str, default="github.com")
+    parser.add_argument(
+        "-y",
+        "--yes",
+        dest="update_repos",
+        action="store_true",
+        help="Whether to update_repos all packages.",
+    )
+    parser.add_argument(
+        "--use_local_repos",
+        action="store_true",
+        default=False,
+        help="Use local repos when existing.",
+    )
+
+    ################# pipeline predict #################
+    parser.add_argument("--pipeline", type=str, help="")
+    parser.add_argument("--input", type=str, default=None, help="")
+    parser.add_argument("--save_path", type=str, default=None, help="")
+    parser.add_argument("--device", type=str, default=None, help="")
+    parser.add_argument("--use_hpip", action="store_true")
+    parser.add_argument("--serial_number", type=str)
+    parser.add_argument("--update_license", action="store_true")
+    parser.add_argument("--get_pipeline_config", type=str, default=None, help="")
+
+    ################# serving #################
+    parser.add_argument("--serve", action="store_true")
+    parser.add_argument("--host", type=str, default="0.0.0.0")
+    parser.add_argument("--port", type=int, default=8080)
+
+    return parser
+
+
+def install(args):
+    """install paddlex"""
+    # Enable debug info
+    os.environ["PADDLE_PDX_DEBUG"] = "True"
+    # Disable eager initialization
+    os.environ["PADDLE_PDX_EAGER_INIT"] = "False"
+
+    plugins = args.plugins[:]
+
+    if "serving" in plugins:
+        plugins.remove("serving")
+        _install_serving_deps()
+        return
+
+    if plugins:
+        repo_names = plugins
+    elif len(plugins) == 0:
+        repo_names = get_all_supported_repo_names()
+    setup(
+        repo_names=repo_names,
+        no_deps=args.no_deps,
+        platform=args.platform,
+        update_repos=args.update_repos,
+        use_local_repos=args.use_local_repos,
+    )
+    return
+
+
+def _get_hpi_params(serial_number, update_license):
+    return {"serial_number": serial_number, "update_license": update_license}
+
+
+def pipeline_predict(
+    pipeline, input, device, save_path, use_hpip, serial_number, update_license
+):
+    """pipeline predict"""
+    hpi_params = _get_hpi_params(serial_number, update_license)
+    pipeline = create_pipeline(
+        pipeline, device=device, use_hpip=use_hpip, hpi_params=hpi_params
+    )
+    result = pipeline(input)
+    for res in result:
+        res.print(json_format=False)
+        if save_path:
+            res.save_all(save_path=save_path)
+
+
+def serve(pipeline, *, device, use_hpip, serial_number, update_license, host, port):
+    from .inference.pipelines.serving import create_pipeline_app, run_server
+
+    hpi_params = _get_hpi_params(serial_number, update_license)
+    pipeline_config = load_pipeline_config(pipeline)
+    pipeline = create_pipeline_from_config(
+        pipeline_config, device=device, use_hpip=use_hpip, hpi_params=hpi_params
+    )
+    app = create_pipeline_app(pipeline, pipeline_config)
+    run_server(app, host=host, port=port, debug=False)
+
+
+# for CLI
+def main():
+    """API for commad line"""
+    args = args_cfg().parse_args()
+    if len(sys.argv) == 1:
+        logging.warning("No arguments provided. Displaying help information:")
+        args_cfg().print_help()
+        return
+
+    if args.install:
+        install(args)
+    elif args.serve:
+        serve(
+            args.pipeline,
+            device=args.device,
+            use_hpip=args.use_hpip,
+            serial_number=args.serial_number,
+            update_license=args.update_license,
+            host=args.host,
+            port=args.port,
+        )
+    else:
+        if args.get_pipeline_config is not None:
+            interactive_get_pipeline(args.get_pipeline_config, args.save_path)
+        else:
+            return pipeline_predict(
+                args.pipeline,
+                args.input,
+                args.device,
+                args.save_path,
+                use_hpip=args.use_hpip,
+                serial_number=args.serial_number,
+                update_license=args.update_license,
+            )

paddlex/pipelines/OCR.yaml

@@ -0,0 +1,8 @@
+Global:
+  pipeline_name: OCR
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_ocr_001.png
+  
+Pipeline:
+  text_det_model: PP-OCRv4_mobile_det
+  text_rec_model: PP-OCRv4_mobile_rec
+  text_rec_batch_size: 1

paddlex/pipelines/PP-ChatOCRv3-doc.yaml

@@ -0,0 +1,27 @@
+Global:
+  pipeline_name: PP-ChatOCRv3-doc
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/contract.pdf
+  #input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/report.png
+Pipeline:
+  layout_model: RT-DETR-H_layout_3cls
+  table_model: SLANet_plus
+  text_det_model: PP-OCRv4_server_det
+  text_rec_model: PP-OCRv4_server_rec
+  seal_text_det_model: PP-OCRv4_server_seal_det
+  doc_image_ori_cls_model: null # PP-LCNet_x1_0_doc_ori
+  doc_image_unwarp_model: null # UVDoc
+  llm_name: "ernie-3.5"
+  llm_params: 
+    api_type: qianfan
+    ak: "api_key" # Set this to a real API key
+    sk: "secret_key"  # Set this to a real secret key
+  task_prompt_yaml: None
+  user_prompt_yaml:
+  layout_batch_size: 1
+  text_det_batch_size: 1
+  text_rec_batch_size: 1
+  table_batch_size: 1
+  doc_image_ori_cls_batch_size: 1
+  doc_image_unwarp_batch_size: 1
+  seal_text_det_batch_size: 1
+  recovery: True

paddlex/pipelines/PP-ShiTuV2.yaml

@@ -0,0 +1,13 @@
+Global:
+  pipeline_name: PP-ShiTuV2
+  input: ./drink_dataset_v2.0/test_images/100.jpeg
+  
+Pipeline:
+  det_model: PP-ShiTuV2_det
+  rec_model: PP-ShiTuV2_rec
+  det_batch_size: 1
+  rec_batch_size: 1
+  device: gpu
+  index: None
+  score_thres: 0.5
+  return_k: 5

paddlex/pipelines/anomaly_detection.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: anomaly_detection
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/uad_grid.png
+  
+Pipeline:
+  model: STFPM
+  batch_size: 1

paddlex/pipelines/face_recognition.yaml

@@ -0,0 +1,13 @@
+Global:
+  pipeline_name: face_recognition
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/friends1.jpg
+
+Pipeline:
+  det_model: "BlazeFace"
+  rec_model: "MobileFaceNet"
+  det_batch_size: 1
+  rec_batch_size: 1
+  device: gpu
+  index: None
+  score_thres: 0.4
+  return_k: 5

paddlex/pipelines/formula_recognition.yaml

@@ -0,0 +1,8 @@
+Global:
+  pipeline_name: formula_recognition
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/demo_image/general_formula_recognition.png
+  
+Pipeline:
+  layout_model: RT-DETR-H_layout_17cls
+  formula_rec_model: LaTeX_OCR_rec
+  formula_rec_batch_size: 5

paddlex/pipelines/image_classification.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: image_classification
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_image_classification_001.jpg
+  
+Pipeline:
+  model: PP-LCNet_x0_5
+  batch_size: 1

paddlex/pipelines/instance_segmentation.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: instance_segmentation
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_instance_segmentation_004.png
+  
+Pipeline:
+  model: Mask-RT-DETR-S
+  batch_size: 1

paddlex/pipelines/layout_parsing.yaml

@@ -0,0 +1,14 @@
+Global:
+  pipeline_name: layout_parsing
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/demo_paper.png
+  # input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/PP-OCRv3.pdf
+  
+Pipeline:
+  layout_model: RT-DETR-H_layout_17cls
+  table_model: SLANet_plus
+  formula_rec_model: LaTeX_OCR_rec
+  text_det_model: PP-OCRv4_server_det
+  text_rec_model: PP-OCRv4_server_rec
+  seal_text_det_model: PP-OCRv4_server_seal_det
+  doc_image_unwarp_model: None
+  doc_image_ori_cls_model: None

paddlex/pipelines/multi_label_image_classification.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: multi_label_image_classification
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_image_classification_001.jpg
+  
+Pipeline:
+  model: PP-LCNet_x1_0_ML
+  batch_size: 1

paddlex/pipelines/object_detection.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: object_detection
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_object_detection_002.png
+  
+Pipeline:
+  model: PicoDet-S
+  batch_size: 1

paddlex/pipelines/pedestrian_attribute_recognition.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: pedestrian_attribute_recognition
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/pedestrian_attribute_002.jpg
+  
+Pipeline:
+  det_model: PP-YOLOE-L_human
+  cls_model: PP-LCNet_x1_0_pedestrian_attribute

paddlex/pipelines/seal_recognition.yaml

@@ -0,0 +1,10 @@
+Global:
+  pipeline_name: seal_recognition
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/seal_text_det.png
+
+Pipeline:
+  layout_model: RT-DETR-H_layout_3cls
+  text_det_model: PP-OCRv4_server_seal_det
+  text_rec_model: PP-OCRv4_server_rec
+  layout_batch_size: 1
+  text_rec_batch_size: 1

paddlex/pipelines/semantic_segmentation.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: semantic_segmentation
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/application/semantic_segmentation/makassaridn-road_demo.png
+  
+Pipeline:
+  model: PP-LiteSeg-T
+  batch_size: 1

paddlex/pipelines/small_object_detection.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: small_object_detection
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/small_object_detection.jpg
+  
+Pipeline:
+  model: PP-YOLOE_plus_SOD-L
+  batch_size: 1

paddlex/pipelines/table_recognition.yaml

@@ -0,0 +1,12 @@
+Global:
+  pipeline_name: table_recognition
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/table_recognition.jpg
+  
+Pipeline:
+  layout_model: PicoDet_layout_1x_table
+  table_model: SLANet_plus
+  text_det_model: PP-OCRv4_mobile_det
+  text_rec_model: PP-OCRv4_mobile_rec
+  layout_batch_size: 1
+  text_rec_batch_size: 1
+  table_batch_size: 1

paddlex/pipelines/ts_ad.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: ts_ad
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_ad.csv
+  
+Pipeline:
+  model: DLinear_ad
+  batch_size: 1

paddlex/pipelines/ts_cls.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: ts_cls
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_cls.csv
+  
+Pipeline:
+  model: TimesNet_cls
+  batch_size: 1

paddlex/pipelines/ts_fc.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: ts_fc
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_fc.csv
+  
+Pipeline:
+  model: DLinear
+  batch_size: 1

paddlex/pipelines/vehicle_attribute_recognition.yaml

@@ -0,0 +1,7 @@
+Global:
+  pipeline_name: vehicle_attribute_recognition
+  input: https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/vehicle_attribute_002.jpg
+  
+Pipeline:
+  det_model: PP-YOLOE-L_vehicle
+  cls_model: PP-LCNet_x1_0_vehicle_attribute

paddlex/repo_apis/PaddleClas_api/__init__.py

@@ -0,0 +1,17 @@
+# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from .cls import ClsModel, ClsRunner, register
+from .shitu_rec import ShiTuRecModel, ShiTuRecRunner, register

paddlex/repo_apis/PaddleClas_api/cls/__init__.py

@@ -0,0 +1,19 @@
+# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from .model import ClsModel
+from .runner import ClsRunner
+from .config import ClsConfig
+from . import register