updated docs

README.md

@@ -84,7 +84,7 @@ Integrate SEA-AI/det-metrics with FiftyOne datasets for enhanced analysis and vi
 ```python
 import evaluate
 import logging
-from seametrics.payload import PayloadProcessor
+from seametrics.payload.processor import PayloadProcessor
 
 logging.basicConfig(level=logging.WARNING)
 

det-metrics.py

@@ -21,6 +21,7 @@ import datasets
 import numpy as np
 
 from seametrics.detection import PrecisionRecallF1Support
+from seametrics.payload import Payload
 
 _CITATION = """\
 @InProceedings{coco:2020,
@@ -193,7 +194,7 @@ class DetectionMetric(evaluate.Metric):
         )
 
     @deprecated(reason="Use `module.from_payload` instead")
-    def add_batch(self, payload, model_name: str = None):
+    def add_batch(self, payload: Payload, model_name: str = None):
         """Takes as input a payload and adds the batch to the metric"""
         self.add_payload(payload, model_name)
 
@@ -201,7 +202,7 @@ class DetectionMetric(evaluate.Metric):
         """Called within the evaluate.Metric.compute() method"""
         return self.coco_metric.compute()["metrics"]
 
-    def add_payload(self, payload, 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.detection.utils import payload_to_det_metric