change to new payload structure

PanopticQuality.py

@@ -19,6 +19,7 @@ import datasets
 import numpy as np
 
 from seametrics.segmentation import PanopticQuality
+from seametrics.payload import Payload
 
 _CITATION = """\
 @inproceedings{DBLP:conf/cvpr/KirillovHGRD19,
@@ -56,13 +57,13 @@ Returns:
     1 is perfect panoptic segmentation, 0 is worst possible panoptic segmentation.
 Examples:
     >>> import evaluate
-    >>> from seametrics.fo_utils.utils import fo_to_payload
+    >>> from seametrics.payload.processor import PayloadProcessor
     >>> MODEL_FIELD = ["maskformer-27k-100ep"]
-    >>> payload = fo_to_payload("SAILING_PANOPTIC_DATASET_QA",
+    >>> payload = PayloadProcessor("SAILING_PANOPTIC_DATASET_QA",
     >>>                         gt_field="ground_truth_det",
     >>>                         models=MODEL_FIELD,
     >>>                         sequence_list=["Trip_55_Seq_2", "Trip_197_Seq_1", "Trip_197_Seq_68"],
-    >>>                         excluded_classes=[""])
+    >>>                         excluded_classes=[""]).payload
     >>> module = evaluate.load("SEA-AI/PanopticQuality")
     >>> module.add_payload(payload, model_name=MODEL_FIELD[0])
     >>> module.compute()
@@ -162,7 +163,7 @@ class PQMetric(evaluate.Metric):
         """Called within the evaluate.Metric.compute() method"""
         return self.pq_metric.compute()
 
-    def add_payload(self, payload: dict, model_name: str = None):
+    def add_payload(self, payload: Payload, model_name: str = None):
         """Converts the payload to the format expected by the metric"""
         # import only if needed since fiftyone is not a direct dependency
         from seametrics.segmentation.utils import payload_to_seg_metric

README.md

@@ -23,13 +23,13 @@ To get started with PanopticQuality, make sure you have the necessary dependenci
 ### Basic Usage
 ```python
 >>> import evaluate
->>> from seametrics.fo_utils.utils import fo_to_payload
+>>> from seametrics.payload.processor import PayloadProcessor
 >>> MODEL_FIELD = ["maskformer-27k-100ep"]
->>> payload = fo_to_payload("SAILING_PANOPTIC_DATASET_QA",
+>>> payload = PayloadProcessor("SAILING_PANOPTIC_DATASET_QA",
 >>>                         gt_field="ground_truth_det",
 >>>                         models=MODEL_FIELD,
 >>>                         sequence_list=["Trip_55_Seq_2", "Trip_197_Seq_1", "Trip_197_Seq_68"],
->>>                         excluded_classes=[""])
+>>>                         excluded_classes=[""]).payload
 >>> module = evaluate.load("SEA-AI/PanopticQuality")
 >>> module.add_payload(payload, model_name=MODEL_FIELD[0])
 >>> module.compute()