paddlex 3.0.0rc0__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

paddlex/inference/pipelines/components/chat_server/openai_bot_chat.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,14 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import re
-import json
 import base64
+import json
+import re
 from typing import Dict
+
 from .....utils import logging
+from .....utils.deps import class_requires_deps
 from .base import BaseChat
 
 
+@class_requires_deps("openai")
 class OpenAIBotChat(BaseChat):
     """OpenAI Bot Chat"""
 
@@ -39,6 +42,8 @@ class OpenAIBotChat(BaseChat):
             api_key is None for api_type is openai.
             ValueError: If end_point is not one of ['completion', 'chat_completion'].
         """
+        from openai import OpenAI
+
         super().__init__()
         model_name = config.get("model_name", None)
         # compatible with historical model name
@@ -63,11 +68,6 @@ class OpenAIBotChat(BaseChat):
                 "end_point must be one of ['completion', 'chat_completion']"
             )
 
-        try:
-            from openai import OpenAI
-        except:
-            raise Exception("openai is not installed, please install it first.")
-
         self.client = OpenAI(base_url=base_url, api_key=api_key)
 
         self.model_name = model_name

paddlex/inference/pipelines/components/common/__init__.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,7 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from .base_result import CVResult, BaseResult
-from .sort_boxes import SortQuadBoxes, SortPolyBoxes
-from .crop_image_regions import CropByPolys, CropByBoxes
+from .base_result import BaseResult, CVResult
 from .convert_points_and_boxes import convert_points_to_boxes
+from .crop_image_regions import CropByBoxes, CropByPolys
+from .sort_boxes import SortPolyBoxes, SortQuadBoxes
+from .warp_image import rotate_image

paddlex/inference/pipelines/components/common/base_operator.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
 # limitations under the License.
 
 from abc import ABC, abstractmethod
+
 from .....utils.subclass_register import AutoRegisterABCMetaClass
 
 

paddlex/inference/pipelines/components/common/base_result.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,8 +14,9 @@
 
 import inspect
 from typing import Dict
+
 from ....utils.io import ImageReader, ImageWriter
-from ..utils.mixin import JsonMixin, ImgMixin, StrMixin
+from ..utils.mixin import ImgMixin, JsonMixin, StrMixin
 
 
 class BaseResult(dict, StrMixin, JsonMixin):

paddlex/inference/pipelines/components/common/convert_points_and_boxes.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 __all__ = ["convert_points_to_boxes"]
 
 import numpy as np
-import copy
 
 
 def convert_points_to_boxes(dt_polys: list) -> np.ndarray:

paddlex/inference/pipelines/components/common/crop_image_regions.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,16 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Tuple, List
 import copy
+from typing import List, Tuple
+
 import numpy as np
-import cv2
-from shapely.geometry import Polygon
 from numpy.linalg import norm
+
+from .....utils.deps import class_requires_deps, is_dep_available
 from .base_operator import BaseOperator
-from ....utils.io import ImageReader
 from .seal_det_warp import AutoRectifier
 
+if is_dep_available("opencv-contrib-python"):
+    import cv2
+if is_dep_available("shapely"):
+    from shapely.geometry import Polygon
+
 
 class CropByBoxes(BaseOperator):
     """Crop Image by Boxes"""
@@ -59,6 +64,7 @@ class CropByBoxes(BaseOperator):
         return output_list
 
 
+@class_requires_deps("opencv-contrib-python", "shapely")
 class CropByPolys(BaseOperator):
     """Crop Image by Polys"""
 

paddlex/inference/pipelines/components/common/seal_det_warp.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,26 +12,37 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os, sys
 import copy
-import time
+
 import numpy as np
-from numpy import cos, sin, arctan, sqrt
-import cv2
+from numpy import arctan, cos, sin, sqrt
+
 from .....utils import logging
+from .....utils.deps import (
+    class_requires_deps,
+    function_requires_deps,
+    is_dep_available,
+)
+
+if is_dep_available("opencv-contrib-python"):
+    import cv2
 
 #### [TODO] need sunting to add explanatory notes
 
 
+@function_requires_deps("opencv-contrib-python")
 def Homography(
     image,
     img_points,
     world_width,
     world_height,
-    interpolation=cv2.INTER_CUBIC,
+    interpolation=None,
     ratio_width=1.0,
     ratio_height=1.0,
 ):
+    if interpolation is None:
+        interpolation = cv2.INTER_CUBIC
+
     _points = np.array(img_points).reshape(-1, 2).astype(np.float32)
 
     expand_x = int(0.5 * world_width * (ratio_width - 1))
@@ -60,13 +71,14 @@ def Homography(
     return dst_img
 
 
+@class_requires_deps("opencv-contrib-python")
 class PlanB:
     def __call__(
         self,
         image,
         points,
         curveTextRectifier,
-        interpolation=cv2.INTER_LINEAR,
+        interpolation=None,
         ratio_width=1.0,
         ratio_height=1.0,
         loss_thresh=5.0,
@@ -84,6 +96,8 @@ class PlanB:
         :param square: crop square image or not. True or False. The default is False
         :return:
         """
+        if interpolation is None:
+            interpolation = cv2.INTER_LINEAR
         h, w = image.shape[:2]
         _points = np.array(points).reshape(-1, 2).astype(np.float32)
         x_min = int(np.min(_points[:, 0]))
@@ -126,6 +140,7 @@ class PlanB:
         return dst_img, loss
 
 
+@class_requires_deps("opencv-contrib-python")
 class CurveTextRectifier:
     """
     spatial transformer via monocular vision
@@ -538,7 +553,7 @@ class CurveTextRectifier:
         img_points,
         obj_points,
         is_horizontal_text,
-        interpolation=cv2.INTER_LINEAR,
+        interpolation=None,
         ratio_width=1.0,
         ratio_height=1.0,
     ):
@@ -546,6 +561,9 @@ class CurveTextRectifier:
         divide and conquer: homography
         # ratio_width and ratio_height must be 1.0 here
         """
+        if interpolation is None:
+            interpolation = cv2.INTER_LINEAR
+
         _img_points = img_points.reshape(-1, 2)
         _obj_points = obj_points.reshape(-1, 3)
 
@@ -607,10 +625,13 @@ class CurveTextRectifier:
         img_points,
         world_width,
         world_height,
-        interpolation=cv2.INTER_CUBIC,
+        interpolation=None,
         ratio_width=1.0,
         ratio_height=1.0,
     ):
+        if interpolation is None:
+            interpolation = cv2.INTER_CUBIC
+
         _points = np.array(img_points).reshape(-1, 2).astype(np.float32)
 
         expand_x = int(0.5 * world_width * (ratio_width - 1))
@@ -642,7 +663,7 @@ class CurveTextRectifier:
         self,
         image_data,
         points,
-        interpolation=cv2.INTER_LINEAR,
+        interpolation=None,
         ratio_width=1.0,
         ratio_height=1.0,
         mode="calibration",
@@ -657,6 +678,9 @@ class CurveTextRectifier:
         :param mode: 'calibration' or 'homography'. when homography, ratio_width and ratio_height must be 1.0
         :return:
         """
+        if interpolation is None:
+            interpolation = cv2.INTER_LINEAR
+
         org_h, org_w = image_data.shape[:2]
         org_size = (org_w, org_h)
         self.image = image_data
@@ -703,6 +727,7 @@ class CurveTextRectifier:
         return dst, ret
 
 
+@class_requires_deps("opencv-contrib-python")
 class AutoRectifier:
     def __init__(self):
         self.npoints = 10
@@ -710,7 +735,7 @@ class AutoRectifier:
 
     @staticmethod
     def get_rotate_crop_image(
-        img, points, interpolation=cv2.INTER_CUBIC, ratio_width=1.0, ratio_height=1.0
+        img, points, interpolation=None, ratio_width=1.0, ratio_height=1.0
     ):
         """
         crop or homography
@@ -721,6 +746,8 @@ class AutoRectifier:
         :param ratio_height:
         :return:
         """
+        if interpolation is None:
+            interpolation = cv2.INTER_CUBIC
         h, w = img.shape[:2]
         _points = np.array(points).reshape(-1, 2).astype(np.float32)
 
@@ -796,7 +823,7 @@ class AutoRectifier:
         self,
         image_data,
         points,
-        interpolation=cv2.INTER_LINEAR,
+        interpolation=None,
         ratio_width=1.0,
         ratio_height=1.0,
         loss_thresh=5.0,
@@ -813,6 +840,8 @@ class AutoRectifier:
         :param mode: 'calibration' or 'homography'. when homography, ratio_width and ratio_height must be 1.0
         :return:
         """
+        if interpolation is None:
+            interpolation = cv2.INTER_LINEAR
         _points = np.array(points).reshape(-1, 2)
         if len(_points) >= self.npoints and len(_points) % 2 == 0:
             try:
@@ -879,7 +908,7 @@ class AutoRectifier:
         self,
         image_data,
         points_list,
-        interpolation=cv2.INTER_LINEAR,
+        interpolation=None,
         ratio_width=1.0,
         ratio_height=1.0,
         loss_thresh=5.0,
@@ -903,6 +932,8 @@ class AutoRectifier:
         for points in points_list:
             if not isinstance(points, list):
                 raise ValueError
+        if interpolation is None:
+            interpolation = cv2.INTER_LINEAR
 
         if ratio_width < 1.0 or ratio_height < 1.0:
             raise ValueError(

paddlex/inference/pipelines/components/common/sort_boxes.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,8 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import numpy as np
 from typing import List
+
+import numpy as np
+
 from .base_operator import BaseOperator
 
 

paddlex/inference/pipelines/components/common/warp_image.py

@@ -0,0 +1,50 @@
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
+#
+# 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 numpy as np
+
+from .....utils.deps import function_requires_deps, is_dep_available
+
+if is_dep_available("opencv-contrib-python"):
+    import cv2
+
+
+@function_requires_deps("opencv-contrib-python")
+def rotate_image(image, angle):
+    if angle < 0 or angle >= 360:
+        raise ValueError("`angle` should be in range [0, 360)")
+
+    if angle < 1e-7:
+        return image
+
+    # Should we align corners?
+    h, w = image.shape[:2]
+    center = (w / 2, h / 2)
+    scale = 1.0
+    mat = cv2.getRotationMatrix2D(center, angle, scale)
+    cos = np.abs(mat[0, 0])
+    sin = np.abs(mat[0, 1])
+    new_w = int((h * sin) + (w * cos))
+    new_h = int((h * cos) + (w * sin))
+    mat[0, 2] += (new_w - w) / 2
+    mat[1, 2] += (new_h - h) / 2
+    dst_size = (new_w, new_h)
+
+    rotated = cv2.warpAffine(
+        image,
+        mat,
+        dst_size,
+        flags=cv2.INTER_CUBIC,
+    )
+    return rotated

paddlex/inference/pipelines/components/faisser.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,16 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
 import pickle
 from pathlib import Path
-import faiss
+
 import numpy as np
 
 from ....utils import logging
-from ...utils.io import YAMLWriter, YAMLReader
+from ....utils.deps import class_requires_deps, is_dep_available
+from ...utils.io import YAMLReader, YAMLWriter
+
+if is_dep_available("faiss-cpu"):
+    import faiss
 
 
+@class_requires_deps("faiss-cpu")
 class IndexData:
     VECTOR_FN = "vector"
     VECTOR_SUFFIX = ".index"
@@ -164,6 +168,7 @@ class FaissIndexer:
         return preds
 
 
+@class_requires_deps("faiss-cpu")
 class FaissBuilder:
 
     SUPPORT_METRIC_TYPE = ("hamming", "IP", "L2")

paddlex/inference/pipelines/components/prompt_engineering/__init__.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from .generate_kie_prompt import GenerateKIEPrompt
 from .generate_ensemble_prompt import GenerateEnsemblePrompt
+from .generate_kie_prompt import GenerateKIEPrompt

paddlex/inference/pipelines/components/prompt_engineering/base.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import inspect
 from abc import ABC, abstractmethod
+
 from .....utils.subclass_register import AutoRegisterABCMetaClass
 
 

paddlex/inference/pipelines/components/prompt_engineering/generate_ensemble_prompt.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
 # limitations under the License.
 
 from typing import Dict
+
 from .base import BaseGeneratePrompt
 
 

paddlex/inference/pipelines/components/prompt_engineering/generate_kie_prompt.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,8 +13,8 @@
 # limitations under the License.
 
 from typing import Dict
+
 from .base import BaseGeneratePrompt
-from .....utils import logging
 
 
 class GenerateKIEPrompt(BaseGeneratePrompt):

paddlex/inference/pipelines/components/retriever/__init__.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from .qianfan_bot_retriever import QianFanBotRetriever
 from .openai_bot_retriever import OpenAIBotRetriever
+from .qianfan_bot_retriever import QianFanBotRetriever

paddlex/inference/pipelines/components/retriever/base.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -11,22 +11,25 @@
 # 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 typing import Dict, List
-from abc import ABC, abstractmethod
-
-import time
 import base64
-
-from langchain.docstore.document import Document
-from langchain.text_splitter import RecursiveCharacterTextSplitter
-from langchain_community.vectorstores import FAISS
-from langchain_community import vectorstores
+import time
+from abc import ABC, abstractmethod
+from typing import List
 
 from paddlex.utils import logging
 
+from .....utils.deps import class_requires_deps, is_dep_available
 from .....utils.subclass_register import AutoRegisterABCMetaClass
 
+if is_dep_available("langchain"):
+    from langchain.docstore.document import Document
+    from langchain.text_splitter import RecursiveCharacterTextSplitter
+if is_dep_available("langchain-community"):
+    from langchain_community import vectorstores
+    from langchain_community.vectorstores import FAISS
+
 
+@class_requires_deps("langchain", "langchain-community")
 class BaseRetriever(ABC, metaclass=AutoRegisterABCMetaClass):
     """Base Retriever"""
 
@@ -112,7 +115,7 @@ class BaseRetriever(ABC, metaclass=AutoRegisterABCMetaClass):
         text_list: List[str],
         block_size: int = 300,
         separators: List[str] = ["\t", "\n", "。", "\n\n", ""],
-    ) -> FAISS:
+    ) -> "FAISS":
         """
         Generates a vector database from a list of texts.
 
@@ -137,12 +140,12 @@ class BaseRetriever(ABC, metaclass=AutoRegisterABCMetaClass):
             vectorstore = FAISS.from_documents(
                 documents=all_splits, embedding=self.embedding
             )
-        except ValueError as e:
+        except ValueError:
             vectorstore = None
 
         return vectorstore
 
-    def encode_vector_store_to_bytes(self, vectorstore: FAISS) -> str:
+    def encode_vector_store_to_bytes(self, vectorstore: "FAISS") -> str:
         """
         Encode the vector store serialized to bytes.
 
@@ -158,7 +161,7 @@ class BaseRetriever(ABC, metaclass=AutoRegisterABCMetaClass):
             vectorstore = self.encode_vector_store(vectorstore.serialize_to_bytes())
         return vectorstore
 
-    def decode_vector_store_from_bytes(self, vectorstore: str) -> FAISS:
+    def decode_vector_store_from_bytes(self, vectorstore: str) -> "FAISS":
         """
         Decode a vector store from bytes according to the specified API type.
 
@@ -191,7 +194,7 @@ class BaseRetriever(ABC, metaclass=AutoRegisterABCMetaClass):
     def similarity_retrieval(
         self,
         query_text_list: List[str],
-        vectorstore: FAISS,
+        vectorstore: "FAISS",
         sleep_time: float = 0.5,
         topk: int = 2,
         min_characters: int = 3500,
@@ -208,7 +211,6 @@ class BaseRetriever(ABC, metaclass=AutoRegisterABCMetaClass):
         Returns:
             str: A concatenated string of all unique contexts found.
         """
-        C = []
         all_C = ""
         if vectorstore is None:
             return all_C

paddlex/inference/pipelines/components/retriever/openai_bot_retriever.py

@@ -1,4 +1,4 @@
-# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+# Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -11,7 +11,7 @@
 # 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 typing import Dict, List
+from typing import Dict
 
 from .base import BaseRetriever