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

paddlex/modules/base/utils/coco_eval.py

@@ -0,0 +1,94 @@
+# 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 argparse
+import os
+import sys
+
+from ....utils.deps import function_requires_deps, is_dep_available
+
+if is_dep_available("pycocotools"):
+    from pycocotools.coco import COCO
+    from pycocotools.cocoeval import COCOeval
+
+
+def parse_args():
+    """Parse input arguments"""
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--prediction_json_path", type=str, default="./bbox.json")
+    parser.add_argument("--gt_json_path", type=str, default="./instance_val.json")
+
+    args = parser.parse_args()
+    return args
+
+
+def json_eval_results(args):
+    """
+    cocoapi eval with already exists bbox.json
+    """
+    prediction_json_path = args.prediction_json_path
+    gt_json_path = args.gt_json_path
+    assert os.path.exists(
+        prediction_json_path
+    ), "The json directory:{} does not exist".format(prediction_json_path)
+    cocoapi_eval(prediction_json_path, "bbox", anno_file=gt_json_path)
+
+
+@function_requires_deps("pycocotools")
+def cocoapi_eval(
+    jsonfile,
+    style,
+    coco_gt=None,
+    anno_file=None,
+    max_dets=(100, 300, 1000),
+    sigmas=None,
+    use_area=True,
+):
+    """
+    Args:
+        jsonfile (str): Evaluation json file, eg: bbox.json
+        style (str): COCOeval style, can be `bbox`
+        coco_gt (str): Whether to load COCOAPI through anno_file,
+                 eg: coco_gt = COCO(anno_file)
+        anno_file (str): COCO annotations file.
+        max_dets (tuple): COCO evaluation maxDets.
+        sigmas (nparray): keypoint labelling sigmas.
+        use_area (bool): If gt annotations (eg. CrowdPose, AIC)
+                         do not have 'area', please set use_area=False.
+    """
+    assert coco_gt is not None or anno_file is not None
+
+    if coco_gt is None:
+        coco_gt = COCO(anno_file)
+    coco_dt = coco_gt.loadRes(jsonfile)
+    if style == "proposal":
+        coco_eval = COCOeval(coco_gt, coco_dt, "bbox")
+        coco_eval.params.useCats = 0
+        coco_eval.params.maxDets = list(max_dets)
+    elif style == "keypoints_crowd":
+        coco_eval = COCOeval(coco_gt, coco_dt, style, sigmas, use_area)
+    else:
+        coco_eval = COCOeval(coco_gt, coco_dt, style)
+    coco_eval.evaluate()
+    coco_eval.accumulate()
+    coco_eval.summarize()
+    # flush coco evaluation result
+    sys.stdout.flush()
+    return coco_eval.stats
+
+
+if __name__ == "__main__":
+    args = parse_args()
+    json_eval_results(args)

paddlex/modules/base/utils/topk_eval.py

@@ -0,0 +1,118 @@
+# 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 argparse
+import json
+import os
+
+import paddle
+
+from ....utils import logging
+
+
+def parse_args():
+    """Parse all arguments"""
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--prediction_json_path", type=str, default="./pre_res.json")
+    parser.add_argument("--gt_val_path", type=str, default="./val.txt")
+    parser.add_argument("--image_dir", type=str)
+    parser.add_argument("--num_classes", type=int)
+
+    args = parser.parse_args()
+    return args
+
+
+class AvgMetrics(paddle.nn.Layer):
+    """Average metrics"""
+
+    def __init__(self):
+        super().__init__()
+        self.avg_meters = {}
+
+    @property
+    def avg(self):
+        """Return average value of each metric"""
+        if self.avg_meters:
+            for metric_key in self.avg_meters:
+                return self.avg_meters[metric_key].avg
+
+    @property
+    def avg_info(self):
+        """Return a formatted string of average values and names"""
+        return ", ".join([self.avg_meters[key].avg_info for key in self.avg_meters])
+
+
+class TopkAcc(AvgMetrics):
+    """Top-k accuracy metric"""
+
+    def __init__(self, topk=(1, 5)):
+        super().__init__()
+        assert isinstance(topk, (int, list, tuple))
+        if isinstance(topk, int):
+            topk = [topk]
+        self.topk = topk
+        self.warned = False
+
+    def forward(self, x, label):
+        """forward function"""
+        if isinstance(x, dict):
+            x = x["logits"]
+
+        output_dims = x.shape[-1]
+
+        metric_dict = dict()
+        for idx, k in enumerate(self.topk):
+            if output_dims < k:
+                if not self.warned:
+                    msg = f"The output dims({output_dims}) is less than k({k}), so the Top-{k} metric is meaningless."
+                    logging.info(msg)
+                    self.warned = True
+                metric_dict[f"top{k}"] = 1
+            else:
+                metric_dict[f"top{k}"] = paddle.metric.accuracy(x, label, k=k).item()
+        return metric_dict
+
+
+def prase_pt_info(pt_info, num_classes):
+    """Parse prediction information to probability vector"""
+    pre_list = [0.0] * num_classes
+    for idx, val in zip(pt_info["class_ids"], pt_info["scores"]):
+        pre_list[idx] = val
+    return pre_list
+
+
+def main(args):
+    """main function"""
+    with open(args.prediction_json_path, "r") as fp:
+        predication_result = json.load(fp)
+    gt_info = {}
+
+    pred = []
+    label = []
+    for line in open(args.gt_val_path):
+        img_file, gt_label = line.strip().split(" ")
+        img_file = img_file.split("/")[-1]
+        gt_info[img_file] = int(gt_label)
+    for pt_info in predication_result:
+        img_file = os.path.relpath(pt_info["file_name"], args.image_dir)
+        pred.append(prase_pt_info(pt_info, args.num_classes))
+        label.append([gt_info[img_file]])
+    metric_dict = TopkAcc()(paddle.to_tensor(pred), paddle.to_tensor(label))
+    logging.info(metric_dict)
+
+
+if __name__ == "__main__":
+    args = parse_args()
+    main(args)

paddlex/modules/doc_vlm/__init__.py

@@ -0,0 +1,18 @@
+# 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.
+
+from .dataset_checker import DocVLMDatasetChecker
+from .evaluator import DocVLMEvaluator
+from .exportor import DocVLMExportor
+from .trainer import DocVLMTrainer

paddlex/modules/doc_vlm/dataset_checker.py

@@ -0,0 +1,29 @@
+# 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.
+
+from ...utils.errors import UnsupportedAPIError
+from ..base import BaseDatasetChecker
+from .model_list import MODELS
+
+
+class DocVLMDatasetChecker(BaseDatasetChecker):
+    """Dataset Checker for Document Vision Language Model"""
+
+    entities = MODELS
+
+    def __init__(self, config):
+        # not support for now
+        raise UnsupportedAPIError(
+            "document vision language models do not support data check for now."
+        )

paddlex/modules/doc_vlm/evaluator.py

@@ -0,0 +1,29 @@
+# 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.
+
+from ...utils.errors import UnsupportedAPIError
+from ..base import BaseEvaluator
+from .model_list import MODELS
+
+
+class DocVLMEvaluator(BaseEvaluator):
+    """Document Vision Language Model Evaluator"""
+
+    entities = MODELS
+
+    def __init__(self, config):
+        # not support for now
+        raise UnsupportedAPIError(
+            "document vision language models do not support evaluate for now."
+        )

paddlex/modules/doc_vlm/exportor.py

@@ -0,0 +1,29 @@
+# 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.
+
+from ...utils.errors import UnsupportedAPIError
+from ..base import BaseExportor
+from .model_list import MODELS
+
+
+class DocVLMExportor(BaseExportor):
+    """Document Vision Language Model Exportor"""
+
+    entities = MODELS
+
+    def __init__(self, config):
+        # not support for now
+        raise UnsupportedAPIError(
+            "document vision language models do not support export for now."
+        )

paddlex/modules/doc_vlm/model_list.py

@@ -0,0 +1,16 @@
+# 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.
+
+
+MODELS = ["PP-DocBee-2B", "PP-DocBee-7B", "PP-Chart2Table", "PP-DocBee2-3B"]

paddlex/modules/doc_vlm/trainer.py

@@ -0,0 +1,41 @@
+# 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.
+
+from ...utils.errors import UnsupportedAPIError
+from ..base import BaseTrainer
+from .model_list import MODELS
+
+
+class DocVLMTrainer(BaseTrainer):
+    """Document Vision Language Model Trainer"""
+
+    entities = MODELS
+
+    def __init__(self, config):
+        # not support for now
+        raise UnsupportedAPIError(
+            "Document vision language models do not support train for now."
+        )
+
+    def update_config(self):
+        """update training config"""
+
+    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()}
+        return train_args

paddlex/modules/face_recognition/__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,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from .trainer import FaceRecTrainer
 from .dataset_checker import FaceRecDatasetChecker
 from .evaluator import FaceRecEvaluator
 from .exportor import FaceRecExportor
+from .trainer import FaceRecTrainer

paddlex/modules/face_recognition/dataset_checker/__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.
@@ -16,8 +16,8 @@ import os
 from pathlib import Path
 
 from ...base import BaseDatasetChecker
-from .dataset_src import check_train, check_val
 from ..model_list import MODELS
+from .dataset_src import check_train, check_val
 
 
 class FaceRecDatasetChecker(BaseDatasetChecker):

paddlex/modules/face_recognition/dataset_checker/dataset_src/__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.

paddlex/modules/face_recognition/dataset_checker/dataset_src/check_dataset.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,12 +15,10 @@
 import os
 import os.path as osp
 import random
-import pickle
+
 from PIL import Image, ImageOps
-from collections import defaultdict
-from tqdm import tqdm
 
-from .....utils.errors import DatasetFileNotFoundError, CheckFailedError
+from .....utils.errors import CheckFailedError, DatasetFileNotFoundError
 from .utils.visualizer import draw_label
 
 

paddlex/modules/face_recognition/dataset_checker/dataset_src/utils/__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.

paddlex/modules/face_recognition/dataset_checker/dataset_src/utils/visualizer.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,12 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
 import numpy as np
-import json
-from pathlib import Path
 import PIL
-from PIL import Image, ImageDraw, ImageFont
+from PIL import ImageDraw, ImageFont
 
 from ......utils.fonts import PINGFANG_FONT_FILE_PATH
 

paddlex/modules/face_recognition/evaluator.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.
@@ -24,7 +24,7 @@ class FaceRecEvaluator(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.update_dataset_cfg()
@@ -41,7 +41,7 @@ class FaceRecEvaluator(BaseEvaluator):
         self.pdx_config.update(ds_cfg)
 
     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/face_recognition/exportor.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.

paddlex/modules/face_recognition/model_list.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.

paddlex/modules/face_recognition/trainer.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.

paddlex/modules/formula_recognition/__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.
@@ -13,6 +13,6 @@
 # limitations under the License.
 
 from .dataset_checker import FormulaRecDatasetChecker
-from .trainer import FormulaRecTrainer
 from .evaluator import FormulaRecEvaluator
 from .exportor import FormulaRecExportor
+from .trainer import FormulaRecTrainer

paddlex/modules/formula_recognition/dataset_checker/__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.
@@ -14,10 +14,10 @@
 
 
 from pathlib import Path
-from ...base import BaseDatasetChecker
-from .dataset_src import check, split_dataset, deep_analyse, convert
 
+from ...base import BaseDatasetChecker
 from ..model_list import MODELS
+from .dataset_src import check, convert, deep_analyse, split_dataset
 
 
 class FormulaRecDatasetChecker(BaseDatasetChecker):

paddlex/modules/formula_recognition/dataset_checker/dataset_src/__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.
@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
+from .analyse_dataset import deep_analyse
 from .check_dataset import check
 from .convert_dataset import convert
 from .split_dataset import split_dataset
-from .analyse_dataset import deep_analyse

paddlex/modules/formula_recognition/dataset_checker/dataset_src/analyse_dataset.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,23 +13,24 @@
 # limitations under the License.
 
 
-import os
-import json
 import math
+import os
 import platform
-from pathlib import Path
-
 from collections import defaultdict
-from PIL import Image
-import cv2
+
 import numpy as np
-import matplotlib.pyplot as plt
-from matplotlib.backends.backend_agg import FigureCanvasAgg
-from matplotlib import font_manager
 
+from .....utils.deps import function_requires_deps, is_dep_available
 from .....utils.file_interface import custom_open
-from .....utils.logging import warning
 from .....utils.fonts import PINGFANG_FONT_FILE_PATH
+from .....utils.logging import warning
+
+if is_dep_available("opencv-contrib-python"):
+    import cv2
+if is_dep_available("matplotlib"):
+    import matplotlib.pyplot as plt
+    from matplotlib import font_manager
+    from matplotlib.backends.backend_agg import FigureCanvasAgg
 
 
 def simple_analyse(dataset_path, images_dict):
@@ -77,10 +78,10 @@ def simple_analyse(dataset_path, images_dict):
     )
 
 
+@function_requires_deps("matplotlib", "opencv-contrib-python")
 def deep_analyse(dataset_path, output, datatype="FormulaRecDataset"):
     """class analysis for dataset"""
     tags = ["train", "val"]
-    all_instances = 0
     labels_cnt = {}
     x_max = []
     classes_max = []

paddlex/modules/formula_recognition/dataset_checker/dataset_src/check_dataset.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.
@@ -17,11 +17,7 @@ import os
 import os.path as osp
 from collections import defaultdict
 
-from PIL import Image
-import json
-import numpy as np
-
-from .....utils.errors import DatasetFileNotFoundError, CheckFailedError
+from .....utils.errors import CheckFailedError, DatasetFileNotFoundError
 
 
 def check(