Fix: Add alias for custom_name in Metric (#233)

* Fixed naming for metrics

* Fix test case

Author: cwognum

polaris/benchmark/_base.py

@@ -171,7 +171,7 @@ def _convert(m: str | dict | Metric) -> Metric:
         unique_names = {m.name for m in unique_metrics}
         if len(unique_names) != len(unique_metrics):
             raise InvalidBenchmarkError(
-                "The benchmark has similarly named metrics. Specify a custom name with Metric(custom_name=...)"
+                "The metrics of a benchmark need to have unique names. Specify a custom name with Metric(custom_name=...)"
             )
 
         return unique_metrics

polaris/evaluate/_metric.py

@@ -285,7 +285,7 @@ class Metric(BaseModel):
 
     label: MetricLabel
     config: GroupedMetricConfig | None = None
-    custom_name: str | None = Field(None, exclude=True)
+    custom_name: str | None = Field(None, exclude=True, alias="name")
 
     # Frozen metadata
     fn: Callable = Field(frozen=True, exclude=True)

tests/test_benchmark.py

@@ -233,7 +233,7 @@ def test_benchmark_duplicate_metrics(test_single_task_benchmark):
         m["main_metric"] = m["metrics"][0]
         SingleTaskBenchmarkSpecification(**m)
 
-    with pytest.raises(ValidationError, match="The benchmark has similarly named metrics"):
+    with pytest.raises(ValidationError, match="The metrics of a benchmark need to have unique names."):
         m["metrics"][0].config.group_by = "MULTICLASS_calc"
         SingleTaskBenchmarkSpecification(**m)