doc/source/ray-core/patterns/unnecessary-ray-get.rst
.. _unnecessary-ray-get:
TLDR: Avoid calling :func:ray.get() <ray.get> unnecessarily for intermediate steps. Work with object references directly, and only call ray.get() at the end to get the final result.
When ray.get() is called, objects must be transferred to the worker/node that calls ray.get(). If you don't need to manipulate the object, you probably don't need to call ray.get() on it!
Typically, it’s best practice to wait as long as possible before calling ray.get(), or even design your program to avoid having to call ray.get() at all.
Anti-pattern:
.. literalinclude:: ../doc_code/anti_pattern_unnecessary_ray_get.py :language: python :start-after: anti_pattern_start :end-before: anti_pattern_end
.. figure:: ../images/unnecessary-ray-get-anti.svg
Better approach:
.. literalinclude:: ../doc_code/anti_pattern_unnecessary_ray_get.py :language: python :start-after: better_approach_start :end-before: better_approach_end
.. figure:: ../images/unnecessary-ray-get-better.svg
Notice in the anti-pattern example, we call ray.get() which forces us to transfer the large rollout to the driver, then again to the reduce worker.
In the fixed version, we only pass the reference to the object to the reduce task.
The reduce worker will implicitly call ray.get() to fetch the actual rollout data directly from the generate_rollout worker, avoiding the extra copy to the driver.
Other ray.get() related anti-patterns are:
ray-get-loopray-get-submission-order