Add package and model versioning - #42
Merged
rogerwwww merged 3 commits intoSep 16, 2026
Merged
Conversation
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.
Following our email discussion, this PR puts in place the versioning we suggested, so you can see how it would work in practice. We've filled in the versions where the repository already documents them and made a suggestion for the rest. Please change any of the numbers or names as you see fit.
Package version
The distribution is called ms_pred again, matching the repository and the import name (it was ms_pred at v1.0.0). The version is set once in ms_pred/init.py and pyproject.toml reads it from there.
We've suggested 1.1.0 as the next release after the existing v1.0.0 tag. Some modules have been renamed since then, such as dag_pred becoming iceberg, so under strict semantic versioning 2.0.0 would be another good option. Either way, the changelog notes that earlier changes weren't recorded, and semantic versioning could apply from this release onwards.
Model versions
ms_pred.model_registry records each model's version separately from the package version:
python -m ms_pred --version prints the package version and the model versions, and CHANGELOG.md starts a 1.1.0 section for these changes.
We checked that setuptools picks up the new name and version, and that python -m ms_pred --version lists everything above. Nothing else in the package changes.