Repository navigation
v1.0.0 Phase 6: Run instead of Logger, model comparison, documentation, release 1.0.0 - #76
Merged
Merged
Conversation
…, documentation and release 1.0.0 - Run.save writes configs, metrics, model and report; pipelines save only with an explicit path - physXAI.utils.logging removed, logging via the 'physXAI' logger (set_log_level) - physXAI.evaluation.comparison: repeat_training and ModelComparison (distributions over seeds, common prediction horizon, box and horizon plots, loads saved runs incl. physXAI 0.x) - User guide, migration guide and API reference, strict docs build and ruff in CI - Executables use Run, new TAir_compare.py; version 1.0.0 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.
An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.
This was referenced Nov 6, 2026
Open
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.
Phase 6 of the 1.0.0 refactoring, the last phase:
Runreplaces the Logger, models can be compared across several training runs each, the documentation is rewritten and the version is 1.0.0. After this merge,refactoring_v1.0.0can go tomain.Runinstead of the LoggerphysXAI.utils.loggingis removed (Logger,get_full_path,create_full_path):Run.save(name, prep, model, td)writes everything about a trained model:{name}_preprocessing.json{name}_model.json{name}_training_data.json(metrics, horizon metrics, history){name}.html(the report)It uses the same file layout as AgentLib-MPC;
save_for_agentlibnow calls it.Saving in
pipeline:pipeline/online_pipelinesave only with an explicitsave_path. There is no default directory anymore.model.trained_modelholds the model of the last pipeline.Logging: messages go through the
physXAIlogger from the standard library.set_log_level('warning')replacesLogger.print_level.Feature selection:
save_result(result, run)writes into a run directory.Model comparison (
physXAI.evaluation.comparison)repeat_training(path, prep, model, seeds=5, run=run, name='ann')trains a model with several seeds and saves each run to<run>/<name>/seed_<seed>/.vary=('split', 'init')).ModelComparisoncollects the runs:ModelComparison.load(run.path)treats each sub directory as a model.{label: dir}, or training data held in memory.Tables:
runs(): seeds, model class, training time.metrics()andhorizon().scores(): one row per run.summary(): per model the number of runs, mean, std, min, median and max.The errors over the horizon are compared on the horizon that all runs reach. This makes models with different outputs comparable, e.g.
Change(T)against the trajectory of an RNN.Plot:
New
executables/bestest_hydronic_heat_pump/TAir_compare.py: LinReg, ANN, a modular model with recursive training and an LSTM, 3 seeds each, about 2 min.reaTZon_y(test, K)The spread across seeds is larger than the differences between the models. With 14 days of BOPTEST data, the test set of each RNN run holds only a single window.
Documentation
TAir_sim_linregrewritten for 1.0 (vTinside the model withModularANN(solver='ols'), and the column alternative).expr,io,training,splitting,windows,comparison, …). The pages for removed modules are gone.mkdocs build --strictpasses. To get there, four docstrings that named parameters missing from their signatures were fixed, and warnings about missing types are switched off.CI and cleanup
quality.yml:ruff checkandmkdocs build --strictfor PRs.gh-pages.ymlalso builds with--strict.regression_prototype.pyis excluded as experimental.test_coverage.py: each test writes into its owntmp_pathrun, so the tests no longer depend on each other through the shared Logger directory (26 integrate modular anns #37).1.0.0; CHANGELOG entry[1.0.0] – 2026-11-06.Tests
Run.save;test_physXAI_plugintests (3 passed) andsimple_mpc_nn_physXAI.run_example(testing=True)pass.TAir_compare.py, pass the smoke run.TAir_compare.pyalso ran with the full number of epochs.🤖 Generated with Claude Code