Skip to content
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

[Data] Add docstring to explain Dataset.deserialize_lineage #47203

Merged
merged 2 commits into from
Aug 21, 2024
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions python/ray/data/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -4777,8 +4777,8 @@ def serialize_lineage(self) -> bytes:
futures, to bytes that can be stored and later deserialized, possibly on a
different cluster.

Note that this will drop all computed data, and that everything is
recomputed from scratch after deserialization.
Note that this uses pickle and will drop all computed data, and that everything
is recomputed from scratch after deserialization.

Use :py:meth:`Dataset.deserialize_lineage` to deserialize the serialized
bytes returned from this method into a Dataset.
Expand Down Expand Up @@ -4866,8 +4866,8 @@ def deserialize_lineage(serialized_ds: bytes) -> "Dataset":
"""
Deserialize the provided lineage-serialized Dataset.

This assumes that the provided serialized bytes were serialized using
:py:meth:`Dataset.serialize_lineage`.
This uses pickle, and assumes that the provided serialized bytes were
serialized using :py:meth:`Dataset.serialize_lineage`.

Examples:

Expand Down