Add documentation of applications.#54
Merged
GernotMaier merged 15 commits intoresiduals-overlearningfrom Mar 25, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the stereo regression diagnostic surface area by caching additional training diagnostics in the model artifact and adding CLI tools to visualize/inspect those cached metrics, alongside README and changelog updates.
Changes:
- Cache per-target generalization and residual-normality statistics during
train_regression(). - Add
diagnostic_utilsplus new diagnostic CLI scripts (generalization gap, PDP, permutation importance, residual normality, SHAP summary) and expose them viapyproject.tomlconsole scripts. - Update README and towncrier fragment describing the new diagnostic capabilities.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
src/eventdisplay_ml/models.py |
Stores additional cached diagnostics (generalization_metrics, residual_normality_stats) during regression training. |
src/eventdisplay_ml/diagnostic_utils.py |
New utility module for loading model artifacts, reconstructing splits, and computing cached diagnostic metrics. |
src/eventdisplay_ml/scripts/diagnostic_generalization_gap.py |
New CLI to plot/train-test RMSE gaps (cache-first with fallback). |
src/eventdisplay_ml/scripts/diagnostic_partial_dependence.py |
New CLI to compute and plot partial dependence diagnostics. |
src/eventdisplay_ml/scripts/diagnostic_permutation_importance.py |
New CLI to compute permutation importance on reconstructed test split. |
src/eventdisplay_ml/scripts/diagnostic_residual_normality.py |
New CLI to compute/plot residual normality diagnostics (cache-first with fallback). |
src/eventdisplay_ml/scripts/diagnostic_shap_summary.py |
Minor logging/cleanup updates around cached SHAP plotting. |
pyproject.toml |
Adds console entry points for the new diagnostic scripts. |
tests/test_train_regression_standardization.py |
Extends regression training tests to validate cached generalization_metrics. |
README.md |
Adds documentation for training/apply workflow and new diagnostic tools. |
docs/changes/53.feature.md |
Updates changelog fragment describing new features/diagnostics. |
.github/dependabot.yml |
Adds Dependabot configuration for GitHub Actions updates. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.