Skip to content

DOC Add section on compatibility of skops format #332

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 28, 2023
Merged

DOC Add section on compatibility of skops format #332

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bda2a8
Add section on compatibility of skops format
BenjaminBossan Mar 28, 2023
7d62ccf
[skip ci] Fixed incorrect section underline
BenjaminBossan Mar 28, 2023
d0b6176
[skip ci] Reviewer: Reword paragraph for clarity
BenjaminBossan Mar 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion docs/persistence.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,8 +218,32 @@ Therefore, you should only load a skops file containing a model of any of those
libraries if you trust them to be secure. It's not a perfect solution, but it's
still better than trusting pickle files, which anyone can tamper with easily.

Backwards compatibility
-----------------------

Compatibility across skops versions
###################################

The skops persistence format is in flux, as we steadily work on improving it,
making it more secure and supporting more types. When we make a change that is
incompatible with existing skops files, the protocol will be bumped to the next
higher number (the protocol can be checked in the schema of the skops file). At
the same time, we will ensure that existing skops files with lower protocol
versions still load as always, even if they contained a bug (in which case we
will warn about it). Therefore, it is generally safe to assume that your skops
files will keep on working with future versions of skops.

You may want to periodically load and dump old skops files using newer versions
of skops to benefit from the updates to the protocol.

One caveat to the backwards compatibility promise is that the skops files have
to be created based on a release version of skops. If you create skops files
using a skops version installed from the main branch, it is possible to end up
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
using a skops version installed from the main branch, it is possible to end up
using a skops version installed from the development branch, it is possible to end up

or put main in backticks to make it code like. Otherwise the sentence might sound odd to the reader.

in an inconsistent state. Therefore, don't use the main branch of skops for
creating skops files intended to be loaded with future skops versions.

Compatibility across sklearn versions
-------------------------------------
#####################################

Using skops to load a model saved in one sklearn version and loading it with
another sklearn version is not recommended, because the behavior of the model
Expand Down