[core] Improve docs for custom serialization for exceptions + add test #56156
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: Sampan S Nayak <sampansnayak2@gmail.com>
Signed-off-by: sampan <sampan@anyscale.com>
…nserializable-exception2 Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: Sampan S Nayak <sampansnayak2@gmail.com>
Signed-off-by: sampan <sampan@anyscale.com>
Signed-off-by: sampan <sampan@anyscale.com>
sampan-s-nayak
changed the title
Signed-off-by: sampan <sampan@anyscale.com>
ray-gardener
bot
added
docs
added 2 commits
September 8, 2025 14:46
Signed-off-by: sampan <sampan@anyscale.com>
…unserializable-exception2 Signed-off-by: sampan <sampan@anyscale.com>
edoakes
reviewed
Sep 8, 2025
| @@ -330,6 +330,42 @@ def f(): | |||
| assert clean_noqa(expected_output) == scrub_traceback(str(excinfo.value)) | |||
|
|
|||
|
|
|||
| def test_exception_with_registered_serializer(shutdown_only): | |||
There was a problem hiding this comment.
this file can probably be converted to using ray_start_regular_shared -- can you try? (separate PR if you prefer)
There was a problem hiding this comment.
Ill raise a separate pr for this
Signed-off-by: sampan <sampan@anyscale.com>
jjyao
reviewed
Sep 9, 2025
| @@ -202,6 +202,61 @@ There are at least 3 ways to define your custom serialization process: | |||
| except TypeError: | |||
| pass | |||
|
|
|||
There was a problem hiding this comment.
Create a link here by doing
.. _custom-exception-serializer
so that later on you can refer in the docstring.
python/ray/exceptions.py
Outdated
| @@ -916,7 +916,8 @@ class UnserializableException(RayError): | |||
| the original exception along with its stack trace that was captured at the | |||
| time of serialization. | |||
|
|
|||
| reference for more details: https://docs.ray.io/en/latest/ray-core/objects/serialization.html | |||
| For more details and how to handle this with custom serializers, see: | |||
| https://docs.ray.io/en/latest/ray-core/objects/serialization.html#custom-serializers-for-exceptions | |||
There was a problem hiding this comment.
Suggested change
| https://docs.ray.io/en/latest/ray-core/objects/serialization.html#custom-serializers-for-exceptions | |
| :ref:`xxx <custom-exception-serializer>` |
Signed-off-by: sampan <sampan@anyscale.com>
|
@jjyao addressed comments |
jjyao
reviewed
Sep 9, 2025
jjyao
approved these changes
Sep 10, 2025
Aydin-ab
pushed a commit
to Aydin-ab/ray-aydin
that referenced
this pull request
Sep 10, 2025
ray-project#56156) Signed-off-by: sampan <sampan@anyscale.com> Signed-off-by: Sampan S Nayak <sampansnayak2@gmail.com> Co-authored-by: sampan <sampan@anyscale.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
builds on top of #55878
Because we are using cloud pickle to deserailize the exception, custom serializers registered using
register_serializeralready work out of the box. This PR adds a test case to cover this usecase, adds a new section to the docs describing what users can do when they run into the issue and updates theUnserializableExceptionerror message to point to the section in the docsRelated issue number
NA
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.