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

paddlex/configs/pipelines/open_vocabulary_detection.yaml

@@ -0,0 +1,12 @@
+
+pipeline_name: open_vocabulary_detection
+
+SubModules:
+  OpenVocabularyDetection:
+    module_name: open_vocabulary_detection
+    model_name: GroundingDINO-T
+    model_dir: null
+    batch_size: 1
+    thresholds:
+      box_threshold: 0.3
+      text_threshold: 0.25

paddlex/configs/pipelines/open_vocabulary_segmentation.yaml

@@ -0,0 +1,13 @@
+pipeline_name: open_vocabulary_segmentation
+
+SubModules:
+  BoxPromptSegmentation:
+    module_name: box_prompt_segmentation
+    model_name: SAM-H_box
+    model_dir: null
+    batch_size: 1
+  PointPromptSegmentation:
+    module_name: point_prompt_segmentation
+    model_name: SAM-H_point
+    model_dir: null
+    batch_size: 1

paddlex/configs/pipelines/pedestrian_attribute_recognition.yaml

@@ -0,0 +1,15 @@
+pipeline_name: pedestrian_attribute_recognition
+
+SubModules:
+  Detection:
+    module_name: object_detection
+    model_name: PP-YOLOE-L_human
+    model_dir: null
+    batch_size: 1
+    threshold: 0.5 
+  Classification:
+    module_name: multilabel_classification
+    model_name: PP-LCNet_x1_0_pedestrian_attribute
+    model_dir: null
+    batch_size: 1
+    threshold: 0.7

paddlex/configs/pipelines/rotated_object_detection.yaml

@@ -0,0 +1,10 @@
+
+pipeline_name: rotated_object_detection
+
+SubModules:
+  RotatedObjectDetection:
+    module_name: rotated_object_detection
+    model_name: PP-YOLOE-R-L
+    model_dir: null
+    batch_size: 1
+    threshold: 0.5

paddlex/configs/pipelines/seal_recognition.yaml

@@ -0,0 +1,51 @@
+
+pipeline_name: seal_recognition
+
+use_doc_preprocessor: True
+use_layout_detection: True
+
+SubModules:
+  LayoutDetection:
+    module_name: layout_detection
+    model_name: PP-DocLayout-L
+    model_dir: null
+    threshold: 0.5
+    layout_nms: True
+    layout_unclip_ratio: 1.0
+    layout_merge_bboxes_mode: "large"
+
+SubPipelines:
+  DocPreprocessor:
+    pipeline_name: doc_preprocessor
+    use_doc_orientation_classify: True
+    use_doc_unwarping: True
+    SubModules:
+      DocOrientationClassify:
+        module_name: doc_text_orientation
+        model_name: PP-LCNet_x1_0_doc_ori
+        model_dir: null
+      DocUnwarping:
+        module_name: image_unwarping
+        model_name: UVDoc
+        model_dir: null
+  SealOCR:
+    pipeline_name: OCR
+    text_type: seal
+    use_doc_preprocessor: False
+    use_textline_orientation: False
+    SubModules:
+      TextDetection:
+        module_name: seal_text_detection
+        model_name: PP-OCRv4_server_seal_det
+        model_dir: null
+        limit_side_len: 736
+        limit_type: min
+        thresh: 0.2
+        box_thresh: 0.6
+        unclip_ratio: 0.5
+      TextRecognition:
+        module_name: text_recognition
+        model_name: PP-OCRv4_server_rec
+        model_dir: null
+        batch_size: 1
+        score_thresh: 0

paddlex/configs/pipelines/semantic_segmentation.yaml

@@ -0,0 +1,10 @@
+
+pipeline_name: semantic_segmentation
+
+SubModules:
+  SemanticSegmentation:
+    module_name: semantic_segmentation
+    model_name: PP-LiteSeg-T
+    model_dir: null
+    batch_size: 1
+    target_size: None

paddlex/configs/pipelines/small_object_detection.yaml

@@ -0,0 +1,10 @@
+
+pipeline_name: small_object_detection
+
+SubModules:
+  SmallObjectDetection:
+    module_name: small_object_detection
+    model_name: PP-YOLOE_plus_SOD-L
+    model_dir: null
+    batch_size: 1
+    threshold: 0.5

paddlex/configs/pipelines/table_recognition.yaml

@@ -0,0 +1,56 @@
+
+pipeline_name: table_recognition
+
+use_doc_preprocessor: True
+use_layout_detection: True
+use_ocr_model: True
+
+SubModules:
+  LayoutDetection:
+    module_name: layout_detection
+    model_name: PP-DocLayout-L
+    model_dir: null
+
+  TableStructureRecognition:
+    module_name: table_structure_recognition
+    model_name: SLANet_plus
+    model_dir: null
+
+SubPipelines:
+  DocPreprocessor:
+    pipeline_name: doc_preprocessor
+    use_doc_orientation_classify: True
+    use_doc_unwarping: True
+    SubModules:
+      DocOrientationClassify:
+        module_name: doc_text_orientation
+        model_name: PP-LCNet_x1_0_doc_ori
+        model_dir: null
+
+      DocUnwarping:
+        module_name: image_unwarping
+        model_name: UVDoc
+        model_dir: null
+
+  GeneralOCR:
+    pipeline_name: OCR
+    text_type: general
+    use_doc_preprocessor: False
+    use_textline_orientation: False
+    SubModules:
+      TextDetection:
+        module_name: text_detection
+        model_name: PP-OCRv4_server_det
+        model_dir: null
+        limit_side_len: 960
+        limit_type: max
+        thresh: 0.3
+        box_thresh: 0.6
+        unclip_ratio: 2.0
+        
+      TextRecognition:
+        module_name: text_recognition
+        model_name: PP-OCRv4_server_rec_doc
+        model_dir: null
+        batch_size: 1
+        score_thresh: 0

paddlex/configs/pipelines/table_recognition_v2.yaml

@@ -0,0 +1,76 @@
+
+pipeline_name: table_recognition_v2
+
+use_doc_preprocessor: True
+use_layout_detection: True
+use_ocr_model: True
+
+SubModules:
+  LayoutDetection:
+    module_name: layout_detection
+    model_name: PP-DocLayout-L
+    model_dir: null
+  
+  TableClassification:
+    module_name: table_classification
+    model_name: PP-LCNet_x1_0_table_cls
+    model_dir: null
+
+  WiredTableStructureRecognition:
+    module_name: table_structure_recognition
+    model_name: SLANeXt_wired
+    model_dir: null
+  
+  WirelessTableStructureRecognition:
+    module_name: table_structure_recognition
+    model_name: SLANeXt_wireless
+    model_dir: null
+  
+  WiredTableCellsDetection:
+    module_name: table_cells_detection
+    model_name: RT-DETR-L_wired_table_cell_det
+    model_dir: null
+  
+  WirelessTableCellsDetection:
+    module_name: table_cells_detection
+    model_name: RT-DETR-L_wireless_table_cell_det
+    model_dir: null
+
+SubPipelines:
+  DocPreprocessor:
+    pipeline_name: doc_preprocessor
+    use_doc_orientation_classify: True
+    use_doc_unwarping: True
+    SubModules:
+      DocOrientationClassify:
+        module_name: doc_text_orientation
+        model_name: PP-LCNet_x1_0_doc_ori
+        model_dir: null
+
+      DocUnwarping:
+        module_name: image_unwarping
+        model_name: UVDoc
+        model_dir: null
+
+  GeneralOCR:
+    pipeline_name: OCR
+    text_type: general
+    use_doc_preprocessor: False
+    use_textline_orientation: False
+    SubModules:
+      TextDetection:
+        module_name: text_detection
+        model_name: PP-OCRv4_server_det
+        model_dir: null
+        limit_side_len: 960
+        limit_type: max
+        thresh: 0.3
+        box_thresh: 0.4
+        unclip_ratio: 2.0
+        
+      TextRecognition:
+        module_name: text_recognition
+        model_name: PP-OCRv4_server_rec_doc
+        model_dir: null
+        batch_size: 1
+        score_thresh: 0

paddlex/configs/pipelines/ts_anomaly_detection.yaml

@@ -0,0 +1,8 @@
+pipeline_name: ts_anomaly_detection
+
+SubModules:
+  TSAnomalyDetection:
+    module_name: ts_anomaly_detection
+    model_name: DLinear_ad
+    model_dir: null
+    batch_size: 1   

paddlex/configs/pipelines/ts_classification.yaml

@@ -0,0 +1,8 @@
+pipeline_name: ts_classification
+
+SubModules:
+  TSClassification:
+    module_name: ts_classification
+    model_name: TimesNet_cls
+    model_dir: null
+    batch_size: 1   

paddlex/configs/pipelines/ts_forecast.yaml

@@ -0,0 +1,8 @@
+pipeline_name: ts_forecast
+
+SubModules:
+  TSForecast:
+    module_name: ts_forecast
+    model_name: DLinear
+    model_dir: null
+    batch_size: 1   

paddlex/configs/pipelines/vehicle_attribute_recognition.yaml

@@ -0,0 +1,15 @@
+pipeline_name: vehicle_attribute_recognition
+
+SubModules:
+  Detection:
+    module_name: object_detection
+    model_name: PP-YOLOE-L_vehicle
+    model_dir: null
+    batch_size: 1  
+    threshold: 0.5  
+  Classification:
+    module_name: multilabel_classification
+    model_name: PP-LCNet_x1_0_vehicle_attribute
+    model_dir: null
+    batch_size: 1
+    threshold: 0.7

paddlex/configs/pipelines/video_classification.yaml

@@ -0,0 +1,9 @@
+pipeline_name: video_classification
+
+SubModules:
+  VideoClassification:
+    module_name: video_classification
+    model_name: PP-TSMv2-LCNetV2_8frames_uniform
+    model_dir: null
+    batch_size: 1    
+    topk: 1

paddlex/configs/pipelines/video_detection.yaml

@@ -0,0 +1,10 @@
+pipeline_name: video_detection
+
+SubModules:
+  VideoDetection:
+    module_name: video_detection
+    model_name: YOWO
+    model_dir: null
+    batch_size: 1    
+    nms_thresh: 0.5
+    score_thresh: 0.8

paddlex/constants.py

@@ -0,0 +1,17 @@
+# 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 typing import Final
+
+MODEL_FILE_PREFIX: Final[str] = "inference"

paddlex/engine.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,13 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
 
+from .model import _ModelBasedConfig
+from .utils.config import get_config, parse_args
+from .utils.errors import raise_unsupported_api_error
+from .utils.flags import INFER_BENCHMARK
 from .utils.lazy_loader import disable_pir_bydefault
 from .utils.result_saver import try_except_decorator
-from .utils.config import parse_args, get_config
-from .utils.errors import raise_unsupported_api_error
-from .model import _ModelBasedConfig
 
 
 class Engine(object):
@@ -47,7 +47,9 @@ class Engine(object):
             return self._model.export()
         elif self._mode == "predict":
             for res in self._model.predict():
-                res.print(json_format=False)
+                if INFER_BENCHMARK:
+                    continue
+                res.print()
                 if self._output:
                     res.save_all(save_path=self._output)
         else:

paddlex/hpip_links.html

@@ -0,0 +1,31 @@
+<!doctype html>
+<html>
+    <head>
+        <title>PaddleX HPIP Links</title>
+    </head>
+    <body>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_python-1.1.0-cp38-cp38-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_python-1.1.0-cp39-cp39-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_python-1.1.0-cp310-cp310-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_python-1.1.0-cp311-cp311-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_python-1.1.0-cp312-cp312-linux_x86_64.whl"></a>
+
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_gpu_python-1.1.0-cp38-cp38-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_gpu_python-1.1.0-cp39-cp39-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_gpu_python-1.1.0-cp310-cp310-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_gpu_python-1.1.0-cp311-cp311-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_gpu_python-1.1.0-cp312-cp312-linux_x86_64.whl"></a>
+
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp38-cp38-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp39-cp39-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp310-cp310-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp311-cp311-linux_x86_64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp312-cp312-linux_x86_64.whl"></a>
+
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp38-cp38-linux_aarch64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp39-cp39-linux_aarch64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp310-cp310-linux_aarch64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp311-cp311-linux_aarch64.whl"></a>
+        <a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/deploy/hpi/ultra_infer/releases/new_hpi/v1.1.0/ultra_infer_npu_python-1.1.0-cp312-cp312-linux_aarch64.whl"></a>
+    </body>
+</html>

paddlex/inference/__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,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from ..utils import logging
 from .models import create_predictor
-from .pipelines import create_pipeline
+from .pipelines import create_pipeline, load_pipeline_config
+from .utils.hpi import HPIConfig
 from .utils.pp_option import PaddlePredictorOption

paddlex/inference/common/__init__.py

@@ -0,0 +1,13 @@
+# 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.

paddlex/inference/common/batch_sampler/__init__.py

@@ -0,0 +1,21 @@
+# 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 .audio_batch_sampler import AudioBatchSampler
+from .base_batch_sampler import BaseBatchSampler
+from .det_3d_batch_sampler import Det3DBatchSampler
+from .doc_vlm_batch_sampler import DocVLMBatchSampler
+from .image_batch_sampler import ImageBatchSampler
+from .ts_batch_sampler import TSBatchSampler
+from .video_batch_sampler import VideoBatchSampler

paddlex/inference/common/batch_sampler/audio_batch_sampler.py

@@ -0,0 +1,83 @@
+# 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 pathlib import Path
+
+from ....utils import logging
+from ....utils.cache import CACHE_DIR
+from ....utils.download import download
+from .base_batch_sampler import BaseBatchSampler
+
+
+class AudioBatchSampler(BaseBatchSampler):
+    def __init__(self):
+        """Initializes the BaseBatchSampler.
+
+        Args:
+            batch_size (int, optional): The size of each batch. Only support 1.
+        """
+        super().__init__()
+        self.batch_size = 1
+
+    def _download_from_url(self, in_path):
+        """Download a file from a URL to a cache directory.
+
+        Args:
+            in_path (str): URL of the file to be downloaded.
+
+        Returns:
+            str: Path to the downloaded file.
+        """
+        file_name = Path(in_path).name
+        save_path = Path(CACHE_DIR) / "predict_input" / file_name
+        download(in_path, save_path, overwrite=True)
+        return save_path.as_posix()
+
+    def sample(self, inputs):
+        """Generate list of input file path.
+
+        Args:
+            inputs (str): file path.
+
+        Yields:
+            list: list of file path.
+        """
+        if isinstance(inputs, str):
+            if inputs.startswith("http"):
+                inputs = self._download_from_url(inputs)
+            yield [inputs]
+        elif isinstance(inputs, list):
+            yield inputs
+        else:
+            raise TypeError(
+                f"Not supported input data type! Only `str` are supported, but got: {type(inputs)}."
+            )
+
+    @BaseBatchSampler.batch_size.setter
+    def batch_size(self, batch_size):
+        """Sets the batch size.
+
+        Args:
+            batch_size (int): The batch size to set.
+
+        Raises:
+            Warning: If the batch size is not equal 1.
+        """
+        # only support batch size 1
+        if batch_size != 1:
+            logging.warning(
+                f"audio batch sampler only support batch size 1, but got {batch_size}."
+            )
+        else:
+            self._batch_size = batch_size

paddlex/inference/common/batch_sampler/base_batch_sampler.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.
+
+from abc import abstractmethod
+from typing import Any, Dict, Iterator, List, Tuple
+
+
+class Batch:
+    def __init__(self):
+        self.instances = []
+        self.input_paths = []
+
+    def append(self, instance, input_path):
+        self.instances.append(instance)
+        self.input_paths.append(input_path)
+
+    def reset(self):
+        self.instances = []
+        self.input_paths = []
+
+    def __len__(self):
+        return len(self.instances)
+
+
+class BaseBatchSampler:
+    """BaseBatchSampler"""
+
+    def __init__(self, batch_size: int = 1) -> None:
+        """Initializes the BaseBatchSampler.
+
+        Args:
+            batch_size (int, optional): The size of each batch. Defaults to 1.
+        """
+        super().__init__()
+        self._batch_size = batch_size
+
+    @property
+    def batch_size(self) -> int:
+        """Gets the batch size."""
+        return self._batch_size
+
+    @batch_size.setter
+    def batch_size(self, batch_size: int) -> None:
+        """Sets the batch size.
+
+        Args:
+            batch_size (int): The batch size to set.
+
+        Raises:
+            AssertionError: If the batch size is not greater than 0.
+        """
+        assert batch_size > 0
+        self._batch_size = batch_size
+
+    def __call__(self, input: Any) -> Iterator[List[Any]]:
+        """
+        Sample batch data with the specified input.
+
+        If input is None and benchmarking is enabled, it will yield batches
+        of random data for the specified number of iterations.
+        Otherwise, it will yield from the apply() function.
+
+        Args:
+            input (Any): The input data to sampled.
+
+        Yields:
+            Iterator[List[Any]]: An iterator yielding the batch data.
+        """
+        yield from self.sample(input)
+
+    @abstractmethod
+    def sample(self, *args: Tuple[Any], **kwargs: Dict[str, Any]) -> Iterator[list]:
+        """sample batch data"""
+        raise NotImplementedError
+
+    @abstractmethod
+    def _rand_batch(self, batch_size: int) -> List[Any]:
+        """rand batch data
+
+        Args:
+            batch_size (int): batch size
+        """
+        raise NotImplementedError