Skip to content

DOC add reference to skops's persistence #25197

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
thomasjpfan merged 7 commits into from
Dec 19, 2022
Merged

DOC add reference to skops's persistence #25197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b7b5198
DOC add reference to skops's persistence
adrinjalali Dec 16, 2022
f9c83ff
reduce diff
adrinjalali Dec 16, 2022
a96190c
avoid running the skops code
adrinjalali Dec 16, 2022
5b51071
skip every single line
adrinjalali Dec 16, 2022
505e509
move as 9.1.2
adrinjalali Dec 17, 2022
65d2cd7
add to related projects
adrinjalali Dec 19, 2022
c5367cd
change to normal code blocks
adrinjalali Dec 19, 2022
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
1 change: 1 addition & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,7 @@
"pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
"joblib": ("https://joblib.readthedocs.io/en/latest/", None),
"seaborn": ("https://seaborn.pydata.org/", None),
"skops": ("https://skops.readthedocs.io/en/stable/", None),
}

v = parse(release)
Expand Down
31 changes: 31 additions & 0 deletions doc/model_persistence.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,37 @@ serialization methods, please refer to this
`talk by Alex Gaynor
<https://pyvideo.org/video/2566/pickles-are-for-delis-not-software>`_.


A more secure format: `skops`
.............................

`skops <https://skops.readthedocs.io/en/stable/>`__ provides a more secure
format via the :mod:`skops.io` module. It avoids using :mod:`pickle` and only
loads files which have types and references to functions which are trusted
either by default or by the user. The API is very similar to ``pickle``, and
you can persist your models as explain in the `docs
<https://skops.readthedocs.io/en/stable/persistence.html>`__ using
:func:`skops.io.dump` and :func:`skops.io.dumps`::

import skops.io as sio
obj = sio.dumps(clf)

And you can load them back using :func:`skops.io.load` and
:func:`skops.io.loads`. However, you need to specify the types which are
trusted by you. You can get existing unknown types in a dumped object / file
using :func:`skops.io.get_untrusted_types`, and after checking its contents,
pass it to the load function::

unknown_types = sio.get_untrusted_types(obj)
clf = sio.loads(obj, trusted=unknown_types)

If you trust the source of the file / object, you can pass ``trusted=True``::

clf = sio.loads(obj, trusted=True)

Please report issues and feature requests related to this format on the `skops
issue tracker <https://github.com/skops-dev/skops/issues>`__.

Interoperable formats
---------------------

Expand Down
4 changes: 4 additions & 0 deletions doc/related_projects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ enhance the functionality of scikit-learn's estimators.
Scikit-learn pipelines to `ONNX <https://onnx.ai/>`_ for interchange and
prediction.

` `skops.io <https://skops.readthedocs.io/en/stable/persistence.html>`__ A
persistence model more secure than pickle, which can be used instead of
pickle in most common cases.

- `sklearn2pmml <https://github.com/jpmml/sklearn2pmml>`_
Serialization of a wide variety of scikit-learn estimators and transformers
into PMML with the help of `JPMML-SkLearn <https://github.com/jpmml/jpmml-sklearn>`_
Expand Down