Skip to content
Simpcat Simpcat Simpcat

simpcat.define_metric()

simpcat.define_metric(
    name: str,
    step_metric: str | None = None,
    summary: str | None = None,
    **kwargs: Any
) -> None

Define metric metadata (custom x-axis, summary aggregation).

No-op if both step_metric and summary are None.

Parameters

Section titled “Parameters”
  • name — The metric name (e.g. “val/loss”).
  • step_metric — Another metric to use as x-axis (e.g. “epoch”).
  • summary — Aggregation type for the run summary table — “min”, “max”, “last”, “mean”, or “best” (resolves to min/max based on goal).

Raises

Section titled “Raises”
  • RuntimeError — If no run is active (call simpcat.init() first).