refactor: rename Metrics to ModelMetrics

Author: mplatzer

mostlyai/qa/_html_report.py

@@ -27,7 +27,7 @@
     HTML_REPORT_TEMPLATE,
     HTML_REPORT_EARLY_EXIT,
 )
-from mostlyai.qa.metrics import Metrics
+from mostlyai.qa.metrics import ModelMetrics
 
 _LOG = logging.getLogger(__name__)
 
@@ -54,7 +54,7 @@ def store_report(
     report_path: Path,
     report_type: Literal["model_report", "data_report"],
     workspace: TemporaryWorkspace,
-    metrics: Metrics | None,
+    metrics: ModelMetrics | None,
     meta: dict,
     acc_uni: pd.DataFrame,
     acc_biv: pd.DataFrame,

mostlyai/qa/metrics.py

@@ -220,7 +220,7 @@ def trim_metric_precision(cls, value):
         return round(value, precision) if value is not None else None
 
 
-class Metrics(CustomBaseModel):
+class ModelMetrics(CustomBaseModel):
     accuracy: Accuracy | None = Field(
         default=None,
         description="Metrics regarding the accuracy of synthetic data, measured as the closeness of discretized lower "

mostlyai/qa/report.py

@@ -36,7 +36,7 @@
     plot_store_univariates,
     plot_store_bivariates,
 )
-from mostlyai.qa.metrics import Metrics, Accuracy, Similarity, Distances
+from mostlyai.qa.metrics import ModelMetrics, Accuracy, Similarity, Distances
 from mostlyai.qa._sampling import calculate_embeddings, pull_data_for_accuracy, pull_data_for_embeddings
 from mostlyai.qa._common import (
     determine_data_size,
@@ -73,7 +73,7 @@ def report(
     max_sample_size_embeddings: int | None = None,
     statistics_path: str | Path | None = None,
     update_progress: ProgressCallback | None = None,
-) -> tuple[Path, Metrics | None]:
+) -> tuple[Path, ModelMetrics | None]:
     """
     Generate HTML report and metrics for assessing synthetic data quality.
 
@@ -353,7 +353,7 @@ def _calculate_metrics(
     sim_cosine_trn_syn: np.float64 | None = None,
     sim_auc_trn_hol: np.float64 | None = None,
     sim_auc_trn_syn: np.float64 | None = None,
-) -> Metrics:
+) -> ModelMetrics:
     do_accuracy = acc_uni is not None and acc_biv is not None
     do_distances = dcr_trn is not None
     do_similarity = sim_cosine_trn_syn is not None
@@ -412,7 +412,7 @@ def _calculate_metrics(
         )
     else:
         distances = Distances()
-    return Metrics(
+    return ModelMetrics(
         accuracy=accuracy,
         similarity=similarity,
         distances=distances,