Skip to content

feat(STEF-3398): tag and validate OpenSTEF model versions - #1148

Merged
egordm merged 8 commits into
mainfrom
feature/STEF-3398-openstef-version-metadata
Oct 21, 2026
Merged

egordm merged 8 commits into
mainfrom
feature/STEF-3398-openstef-version-metadata

Conversation

@egordm

@egordm egordm commented Oct 19, 2026 •

Copy link
Copy Markdown
Collaborator

What does this PR do?

Adds OpenSTEF model-version provenance and opt-in compatibility checks for MLflow-backed models. Training runs are tagged with the installed openstef-core version. Consumers can enable enforcement with MLFlowStorage(enforce_version_compatibility=True); incompatible or untagged runs are then rejected with OpenSTEFVersionCompatibilityError and excluded from reuse and model selection. Applications should preflight compatibility before fetching expensive forecast inputs; OpenSTEF’s model-load check is a later safety net.

Rollout plan: compatibility enforcement is opt-in initially to avoid surprising existing users. We plan to make it enabled by default (opt-out) on 2026-11-19, one month after this change.

Closes #

Type of change

  • Bug fix
  • New feature
  • Breaking change (see checklist below)
  • Documentation
  • Refactor / chore / CI

Breaking changes checklist

  • Public API, config schema, or serialized/pickled objects changed in a way that affects existing users
  • If yes: see the breaking changes guide for the pickle/_migrate_state migration pattern

Migration path for existing users:

No migration is required unless a consumer opts in. Before enforcement becomes enabled by default, existing untagged models should be retrained or enforcement explicitly disabled.

AI disclosure

  • No AI assistance was used (beyond grammar/spelling)
  • AI assistance was used — tool(s): GitHub Copilot
    • I have reviewed, understand, and can explain all AI-generated code in this PR
    • AI assistance is disclosed in the commit history.

Checklist

  • poe all --check passes locally (focused tests, lint, formatting, and type checks pass; full docs build has unrelated existing warnings/errors)
  • Tests added/updated for the change
  • Documentation updated (docstrings, user guide, examples) if needed
  • Commits are signed off per our DCO (git commit -s)
  • PR title follows Conventional Commits (e.g. feat: ..., fix: ..., feat!: ... for breaking changes)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
@egordm
egordm requested a review from a team October 19, 2026 13:46
@github-actions github-actions Bot added the feature New feature or request label Oct 19, 2026
@egordm

egordm commented Oct 19, 2026

Copy link
Copy Markdown
Collaborator Author

Closing this PR because it was opened before the author asked for publication. The feature branch and commit are retained; it can be reopened after explicit approval with the repository PR template completed.

@egordm egordm closed this Oct 19, 2026
@egordm egordm reopened this Oct 19, 2026
egordm and others added 7 commits October 19, 2026 16:19
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Keep existing users unaffected by default during rollout. The PR plans to enable enforcement by default on 2026-11-19.

Assisted-by: GitHub Copilot

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
Signed-off-by: Egor Dmitriev <egor.dmitriev@alliander.com>
@sonarqubecloud

Copy link
Copy Markdown

@egordm
egordm merged commit 25f6745 into main Oct 21, 2026
7 checks passed
@egordm
egordm deleted the feature/STEF-3398-openstef-version-metadata branch October 21, 2026 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New feature or request

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants