diff --git a/CHANGELOG.md b/CHANGELOG.md index f6a0eda..5e73ee5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,49 @@ This changelog is generated using [Towncrier](https://towncrier.readthedocs.io/) +## [v2.0.0](https://github.com/Eventdisplay/Eventdisplay-ML/releases/tag/v2.0.0) - 2026-04-03 + +### New Features + +- Add `--max_tel_per_type 10` argument to restrict the number of telescope parameters per telescope type. + Fix bug in indexing arrays with non-continuous telescope identifiers. ([#49](https://github.com/Eventdisplay/Eventdisplay-ML/pull/49)) +- Improve stereo reconstruction by adding the geometrical feature img2_ang. + Change clipping min for size to '1' (applicable for small images in SSTs). + Add preview_rows as command line parameter to allow flexible printout for debugging. ([#51](https://github.com/Eventdisplay/Eventdisplay-ML/pull/51)) +- **Algorithm improvements** + + * Switch to residual learning (predict corrections to baseline reconstructions) + * Add target standardization for balanced multi-target training + * Introduce energy-bin weighting with low-statistics suppression + * Refine XGBoost training (regularization, early stopping, updated hyperparameters) + +- **New features** + + * Training diagnostics with cached metrics (generalization gap, residual normality) + * SHAP feature importance caching per target + * Diagnostic scripts and CLI tools for evaluation and interpretability + * Reproducible diagnostics via model metadata reconstruction + * Expanded test suite and improved error handling + + + ([#53](https://github.com/Eventdisplay/Eventdisplay-ML/pull/53)) + +### Maintenance + +- Update g/h separation to new sorting scheme of telescope-dependent variables. ([#45](https://github.com/Eventdisplay/Eventdisplay-ML/pull/45)) +- Add early stopping to classification. Increase number of estimators. ([#48](https://github.com/Eventdisplay/Eventdisplay-ML/pull/48)) +- Add detailed copilot instructions. ([#50](https://github.com/Eventdisplay/Eventdisplay-ML/pull/50)) + +### Bugfixes + +* Correct log10 handling for energy residuals +* Fix scaler loading/inversion in apply pipeline +* Fix energy-bin weighting logic +* Ensure safe energy validation (ErecS) without dropping rows +* Align evaluation metrics with residual formulation +* Resolve pandas/sklearn warnings and compatibility issues + + ## [v1.0.0](https://github.com/Eventdisplay/Eventdisplay-ML/releases/tag/v1.0.0) - 2026-01-29 First fully stable release of Eventdisplay-ML for stereo (direction and energy) reconstruction. diff --git a/LICENSE b/LICENSE index 6baf95d..cc4bf33 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2025, Eventdisplay +Copyright (c) 2025-2026, Eventdisplay (Gernot Maier, DESY) Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/docs/changes/45.maintenance.md b/docs/changes/45.maintenance.md deleted file mode 100644 index 113a390..0000000 --- a/docs/changes/45.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Update g/h separation to new sorting scheme of telescope-dependent variables. diff --git a/docs/changes/48.maintenance.md b/docs/changes/48.maintenance.md deleted file mode 100644 index fe5cf67..0000000 --- a/docs/changes/48.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Add early stopping to classification. Increase number of estimators. diff --git a/docs/changes/49.feature.md b/docs/changes/49.feature.md deleted file mode 100644 index 0f59b86..0000000 --- a/docs/changes/49.feature.md +++ /dev/null @@ -1,2 +0,0 @@ -Add `--max_tel_per_type 10` argument to restrict the number of telescope parameters per telescope type. -Fix bug in indexing arrays with non-continuous telescope identifiers. diff --git a/docs/changes/50.maintenance.md b/docs/changes/50.maintenance.md deleted file mode 100644 index 7a41420..0000000 --- a/docs/changes/50.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Add detailed copilot instructions. diff --git a/docs/changes/51.feature.md b/docs/changes/51.feature.md deleted file mode 100644 index 75a7d43..0000000 --- a/docs/changes/51.feature.md +++ /dev/null @@ -1,3 +0,0 @@ -Improve stereo reconstruction by adding the geometrical feature img2_ang. -Change clipping min for size to '1' (applicable for small images in SSTs). -Add preview_rows as command line parameter to allow flexible printout for debugging. diff --git a/docs/changes/53.feature.md b/docs/changes/53.feature.md deleted file mode 100644 index 34ad431..0000000 --- a/docs/changes/53.feature.md +++ /dev/null @@ -1,23 +0,0 @@ -* **Algorithm improvements** - - * Switch to residual learning (predict corrections to baseline reconstructions) - * Add target standardization for balanced multi-target training - * Introduce energy-bin weighting with low-statistics suppression - * Refine XGBoost training (regularization, early stopping, updated hyperparameters) - -* **New features** - - * Training diagnostics with cached metrics (generalization gap, residual normality) - * SHAP feature importance caching per target - * Diagnostic scripts and CLI tools for evaluation and interpretability - * Reproducible diagnostics via model metadata reconstruction - * Expanded test suite and improved error handling - -* **Bug fixes** - - * Correct log10 handling for energy residuals - * Fix scaler loading/inversion in apply pipeline - * Fix energy-bin weighting logic - * Ensure safe energy validation (ErecS) without dropping rows - * Align evaluation metrics with residual formulation - * Resolve pandas/sklearn warnings and compatibility issues