Skip to content

DOC add warning on skops convert #434

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
adrinjalali merged 1 commit into from
Jul 16, 2024
Merged

DOC add warning on skops convert #434

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions docs/persistence.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,11 @@ Skops has a command line interface to:
``skops convert``
~~~~~~~~~~~~~~~~~

.. warning::
This command loads the given pickle file(s) to retrieve the objects and
then saves them to a skops file. Therefore you should only use this on
files which you absolutely trust.

To convert a file from the command line, use the ``skops convert`` entrypoint.

Below is an example call to convert a file ``my_model.pkl`` to ``my_model.skops``:
Expand Down