feat: add model serialization API with version metadata (#892)#929
Open
genrichez wants to merge 1 commit into
Open
feat: add model serialization API with version metadata (#892)#929genrichez wants to merge 1 commit into
genrichez wants to merge 1 commit into
Conversation
Adds save()/load() methods to all meta-learners via a SerializableLearner
mixin on BaseLearner. Models are persisted with joblib and include metadata
(causalml version, python version, class name, timestamp) to prevent stale
model execution in production.
API:
learner.save('model.causalml')
loaded = BaseTRegressor.load('model.causalml')
loaded = load_learner('model.causalml') # generic, no class check
Safety:
- Version mismatch warning on load
- Class mismatch raises ValueError
- Unfitted model save raises ValueError
- Missing file raises FileNotFoundError
- Raw joblib fallback with warning
Signed-off-by: genrichez <genrichez@users.noreply.github.com>
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.
Closes #892.
Summary
Adds
save()andload()methods to all causal meta-learners (T, S, X, R, DR) via aSerializableLearnermixin onBaseLearner. Models are persisted using joblib and include metadata (causalml version, python version, class name, timestamp) to prevent stale model execution in production.Usage
Safety features
CausalMLVersionMismatchWarningis raised on loadValueErrorsave()beforefit()raisesValueErrorFileNotFoundErroron bad pathFiles changed
causalml/inference/meta/serialization.py(new) - theSerializableLearnermixincausalml/inference/meta/base.py- added mixin toBaseLearnerinheritancecausalml/inference/meta/__init__.py- exportedload_learnerandCausalMLVersionMismatchWarningtests/test_serialization.py(new) - 19 unit testsTesting