Anti-pattern: Redefining the same remote function or class harms performance

TLDR: Avoid redefining the same remote function or class.

Decorating the same function or class multiple times using the :func:ray.remote <ray.remote> decorator leads to slow performance in Ray. For each Ray remote function or class, Ray will pickle it and upload to GCS. Later on, the worker that runs the task or actor will download and unpickle it. Each decoration of the same function or class generates a new remote function or class from Ray's perspective. As a result, the pickle, upload, download and unpickle work will happen every time we redefine and run the remote function or class.

Code example

Anti-pattern:

.. literalinclude:: ../doc_code/anti_pattern_redefine_task_actor_loop.py :language: python :start-after: anti_pattern_start :end-before: anti_pattern_end

Better approach:

.. literalinclude:: ../doc_code/anti_pattern_redefine_task_actor_loop.py :language: python :start-after: better_approach_start :end-before: better_approach_end

We should define the same remote function or class outside of the loop instead of multiple times inside a loop so that it's pickled and uploaded only once.