Update ref-metrics.py

ref-metrics.py

@@ -101,11 +101,33 @@ class UserFriendlyMetrics(evaluate.Metric):
         debug: bool = False,
     ):
         """
-        Call the required functions to compute the metrics and return it.
+        Compute the metric from the payload.
+
+        Args:
+            payload (Payload): The payload to compute the metric from.
+            **kwargs: Additional keyword arguments.
 
         Returns:
-            dict: A dictionary containing the computed metrics based on the provided area in the area_ranges_tuples,
-            if a range area is provided it will be displayed in the output.
+            dict: The computed metric results with the following format:
+            {
+              "model_name": {
+                "overall": {
+                  "all": {"tp": ..., "fp": ..., "fn": ..., "f1": ...},
+                  ...  # more area ranges
+                },
+                "per_sequence": {
+                  "sequence_name": {
+                    "all": {...},
+                    ...  # more area ranges
+                  },
+                  ...  # more sequences
+                }
+              },
+              ...  # more models
+            }
+        
+        Note:
+        - If the metric does not support area ranges, the metric should store the results under the `all` key.
         """
         return self.dummy_values(area_ranges_tuples)