ray icon indicating copy to clipboard operation
ray copied to clipboard

[core] Update the `ray.get` documentation to clarify when an exception gets raised for a list of object refs

Open justinvyu opened this issue 1 year ago • 1 comments

Description

This bug highlighted a gap in the documentation: https://github.com/ray-project/ray/issues/47204

It's unclear when an error gets raised when one of the N tasks in a ray.get call fails. The expected behavior should be raising immediately any one of the tasks fails.

Link

https://docs.ray.io/en/latest/ray-core/api/doc/ray.get.html#ray.get

Exception – An exception is raised if the task that created the object or that created one of the objects raised an exception.

justinvyu avatar Aug 20 '24 22:08 justinvyu

Correct behavior is when something fails it should immediately raise an exception...

anyscalesam avatar Aug 26 '24 21:08 anyscalesam

@dentiny can you take this?

jjyao avatar Sep 18 '24 04:09 jjyao

@dentiny can you take this?

Sure, seems a good opportunity to learn ray behavior :-) Let me know if I mis-understand.

dentiny avatar Sep 18 '24 10:09 dentiny