-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ENH] Introduce Serialization Support #154
Draft
achieveordie
wants to merge
2
commits into
sktime:main
Choose a base branch
from
achieveordie:introduce_serialization
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# -*- coding: utf-8 -*- | ||
# copyright: skbase developers, BSD-3-Clause License (see LICENSE file) | ||
"""Utilities for serializing and deserializing objects. | ||
|
||
IMPORTANT CAVEAT FOR DEVELOPERS: | ||
Do not add estimator specific functionality to the `load` utility. | ||
All estimator specific functionality should be in | ||
the class methods `load_from_serial` and `load_from_path`. | ||
""" | ||
|
||
__author__ = ["fkiraly", "achieveordie"] | ||
|
||
|
||
def load(serial): | ||
"""Load an object either from in-memory object or from a file location. | ||
|
||
Parameters | ||
---------- | ||
serial : serialized container (tuple), str (path), or Path object (reference) | ||
if serial is a tuple (serialized container): | ||
Contains two elements, first in-memory metadata and second | ||
the related object. | ||
if serial is a string (path reference): | ||
The name of the file without the extension, for e.g: if the file | ||
is `estimator.zip`, `serial='estimator'`. It can also represent a | ||
path, for eg: if location is `home/stored/models/estimator.zip` | ||
then `serial='home/stored/models/estimator'`. | ||
if serial is a Path object (path reference): | ||
`serial` then points to the `.zip` file into which the | ||
object was stored using class method `.save()` of an estimator. | ||
|
||
Returns | ||
------- | ||
Deserialized self resulting in output `serial`, of `cls.save` | ||
""" | ||
import pickle | ||
from pathlib import Path | ||
from zipfile import ZipFile | ||
|
||
if isinstance(serial, tuple): | ||
if len(serial) != 2: | ||
raise ValueError( | ||
"`serial` should be a tuple of size 2 " | ||
f"found, a tuple of size: {len(serial)}" | ||
) | ||
cls, stored = serial | ||
return cls.load_from_serial(stored) | ||
|
||
elif isinstance(serial, (str, Path)): | ||
path = Path(serial + ".zip") if isinstance(serial, str) else serial | ||
if not path.exists(): | ||
raise FileNotFoundError(f"The given save location: {serial}\nwas not found") | ||
with ZipFile(path) as file: | ||
cls = pickle.loads(file.open("_metadata", "r").read()) | ||
return cls.load_from_path(path) | ||
else: | ||
raise TypeError( | ||
"serial must either be a serialized in-memory sktime object, " | ||
"a str, Path or ZipFile pointing to a file which is a serialized sktime " | ||
"object, created by save of an sktime object; but found serial " | ||
f"of type {serial}" | ||
) |
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.
Check warning
Code scanning / CodeQL
File is not always closed