Skip to content

Allow to overwrite metric files #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
treigerm merged 1 commit into from
May 27, 2026
Merged

Allow to overwrite metric files #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions src/climatebenchpress/compressor/scripts/compute_metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ def compute_metrics(
include_dataset: None | Iterable[str] = None,
exclude_compressor: Iterable[str] = tuple(),
include_compressor: None | Iterable[str] = None,
overwrite: bool = False,
):
"""Compute evaluation metrics for compressors.

Expand All @@ -54,6 +55,9 @@ def compute_metrics(
include_compressor : None | Iterable[str]
Compressors to include in evaluation. If `None`, all compressors are included.
If specified, only compressors in `include_compressor` will be evaluated.
overwrite : bool
If `True`, overwrite existing `metrics.csv` and `tests.csv` files. Otherwise,
existing files are read and returned without recomputation.
"""
exclude_compressor = add_compressor_suffixes(exclude_compressor)
include_compressor = add_compressor_suffixes(include_compressor)
Expand Down Expand Up @@ -106,8 +110,16 @@ def compute_metrics(
)
compressor_metrics.mkdir(parents=True, exist_ok=True)

compute_compressor_metrics(compressor_metrics, ds, ds_new)
compute_tests(compressor_metrics, variable2error_bound, ds, ds_new)
compute_compressor_metrics(
compressor_metrics, ds, ds_new, overwrite=overwrite
)
compute_tests(
compressor_metrics,
variable2error_bound,
ds,
ds_new,
overwrite=overwrite,
)


def add_compressor_suffixes(compressors: None | Iterable[str]) -> list[str]:
Expand Down Expand Up @@ -171,10 +183,13 @@ def parse_error_bounds(error_bound_str: str) -> dict[str, tuple[str, float]]:


def compute_compressor_metrics(
compressor_metrics: Path, ds: xr.Dataset, ds_new: xr.Dataset
compressor_metrics: Path,
ds: xr.Dataset,
ds_new: xr.Dataset,
overwrite: bool = False,
) -> pd.DataFrame:
metrics_path = compressor_metrics / "metrics.csv"
if metrics_path.exists():
if metrics_path.exists() and not overwrite:
return pd.read_csv(metrics_path)

metric_list = []
Expand Down Expand Up @@ -206,9 +221,10 @@ def compute_tests(
variable2bound: dict[str, tuple[str, float]],
ds: xr.Dataset,
ds_new: xr.Dataset,
overwrite: bool = False,
) -> pd.DataFrame:
tests_path = compressor_metrics / "tests.csv"
if tests_path.exists():
if tests_path.exists() and not overwrite:
return pd.read_csv(tests_path)

test_list = []
Expand Down Expand Up @@ -336,6 +352,7 @@ def merge_metrics(
parser.add_argument("--include-dataset", type=str, nargs="+", default=None)
parser.add_argument("--exclude-compressor", type=str, nargs="+", default=[])
parser.add_argument("--include-compressor", type=str, nargs="+", default=None)
parser.add_argument("--overwrite", action="store_true")
args = parser.parse_args()
compute_metrics(
basepath=args.basepath,
Expand All @@ -344,4 +361,5 @@ def merge_metrics(
include_dataset=args.include_dataset,
exclude_compressor=args.exclude_compressor,
include_compressor=args.include_compressor,
overwrite=args.overwrite,
)
Loading