Skip to content

DOC make the persistence warning the same as the user guide #259

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
BenjaminBossan merged 1 commit into from
Dec 19, 2022
Merged

DOC make the persistence warning the same as the user guide #259

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
28 changes: 12 additions & 16 deletions skops/io/_persist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,9 @@ def dump(obj: Any, file: str | Path | BinaryIO) -> None:

.. warning::

This feature is very early in development, which means the API is
unstable and it is **not secure** at the moment. Therefore, use the same
caution as you would for ``pickle``: Don't load from sources that you
don't trust. In the future, more security will be added.
This feature is heavily under development, which means the API is
unstable and there might be security issues at the moment. Therefore,
use caution when loading files from sources you don't trust.

Parameters
----------
Expand All @@ -78,10 +77,9 @@ def dumps(obj: Any) -> bytes:

.. warning::

This feature is very early in development, which means the API is
unstable and it is **not secure** at the moment. Therefore, use the same
caution as you would for ``pickle``: Don't load from sources that you
don't trust. In the future, more security will be added.
This feature is heavily under development, which means the API is
unstable and there might be security issues at the moment. Therefore,
use caution when loading files from sources you don't trust.

Parameters
----------
Expand All @@ -102,10 +100,9 @@ def load(file: str | Path, trusted: bool | Sequence[str] = False) -> Any:

.. warning::

This feature is very early in development, which means the API is
unstable and it is **not secure** at the moment. Therefore, use the same
caution as you would for ``pickle``: Don't load from sources that you
don't trust. In the future, more security will be added.
This feature is heavily under development, which means the API is
unstable and there might be security issues at the moment. Therefore,
use caution when loading files from sources you don't trust.

Parameters
----------
Expand Down Expand Up @@ -141,10 +138,9 @@ def loads(data: bytes, trusted: bool | Sequence[str] = False) -> Any:

.. warning::

This feature is very early in development, which means the API is
unstable and it is **not secure** at the moment. Therefore, use the same
caution as you would for ``pickle``: Don't load from sources that you
don't trust. In the future, more security will be added.
This feature is heavily under development, which means the API is
unstable and there might be security issues at the moment. Therefore,
use caution when loading files from sources you don't trust.

Parameters
----------
Expand Down