add method parameter to PanopticQuality + update readme

PanopticQuality.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """TODO: Add a description here."""
-from typing import Dict, List, Tuple
+from typing import Dict, List, Tuple, Literal
 
 import evaluate
 import datasets
@@ -86,7 +86,8 @@ class PQMetric(evaluate.Metric):
                                         (0**2, 6**2),
                                         (6**2, 12**2),
                                         (12**2, 1e5**2)],
-        class_agnostic = False,
+        method: Literal["iou", "hungarian"] = "iou",
+        class_agnostic: bool = False,
         **kwargs
     ):
         super().__init__(**kwargs)
@@ -144,7 +145,8 @@ class PQMetric(evaluate.Metric):
             stuffs=set([self.label2id[label] for label in self.label2id.keys() if label in self.stuff]),
             return_per_class=per_class,
             return_sq_and_rq=split_sq_rq,
-            areas=area_rng
+            areas=area_rng,
+            method=method
         )
         self.cont_to_cat = {label:key for key, label in self.pq_metric.metric.cat_id_to_continuous_id.items()}
 

README.md

@@ -179,7 +179,7 @@ Finished!
 ```
 
 ## Metric Settings
-The metric takes four optional input parameters: __label2id__, __stuff__, __per_class__ and __split_sq_rq__.
+The metric takes four optional input parameters: __label2id__, __stuff__, __per_class__, __split_sq_rq__, __area_rng__, __class_agnostic__ and __method__.
 
 * `label2id: Dict[str, int]`: this dictionary is used to map string labels to an integer representation.
     if not provided a default setting will be used:
@@ -215,7 +215,12 @@ The metric takes four optional input parameters: __label2id__, __stuff__, __per_
 * `area_rng: List[Tuple[float]]`: The list holds all the area ranges for which results are calculated.
     Each range is represented by a Tuple, where the first element is the lower limit and the second is the upper limit of the area range.
     Each value represents total number of pixels of a mask.
-    The parameter defaults to [(0, 1e8)].
+    The parameter defaults to [(0, 1e5 ** 2),(0 ** 2, 6 ** 2),(6 ** 2, 12 ** 2),(12 ** 2, 1e5 ** 2)].
+* `class_agnostic: bool = False`: If true, all instance labels will be merged to a single instance class (class agnostic), while semantic classes are preserved.
+* `method: Litera["iou", "hungarian"] = "hungarian"`: Controls the method used to match predictions to ground truths.
+       If "iou", then a prediction is matched with a ground truth if IOU > 0.5 (https://arxiv.org/pdf/1801.00868). Can lead to unintuitive results.
+       If "hungarian", then predictions are matched with a ground truth by an hungarian optimizer, which allows also matches with 0 < iou <= 0.5 (https://arxiv.org/abs/2309.04887).
+       Both methods result in a one-to-one mapping.
 
 ## Output Values
 A dictionary containing the following keys: