hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-06 18:41:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix docs - atexit is not called when you ray.kill() an actor (#10367)

Browse source
This commit is contained in:
Edward Oakes 2020-08-28 13:51:10 -05:00 • committed by GitHub
parent d76d4822bd
commit 94a069e575
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/source/actors.rst
View file

@ -149,10 +149,12 @@ approach should generally not be necessary as actors are automatically garbage
collected. The ``ObjectRef`` resulting from the task can be waited on to wait collected. The ``ObjectRef`` resulting from the task can be waited on to wait
for the actor to exit (calling ``ray.get()`` on it will raise a ``RayActorError``). for the actor to exit (calling ``ray.get()`` on it will raise a ``RayActorError``).
Note that this method of termination will wait until any previously submitted Note that this method of termination will wait until any previously submitted
tasks finish executing. If you want to terminate an actor immediately, you can tasks finish executing and then exit the process gracefully with sys.exit. If you
call ``ray.kill(actor_handle)``. This will cause the actor to exit immediately want to terminate an actor forcefully, you can call ``ray.kill(actor_handle)``.
and any pending tasks to fail. Any exit handlers installed in the actor using This will call the exit syscall from within the actor, causing it to exit
``atexit`` will be called. immediately and any pending tasks to fail. This will not go through the normal
Python sys.exit teardown logic, so any exit handlers installed in the actor using
``atexit`` will not be called.
Passing Around Actor Handles Passing Around Actor Handles
---------------------------- ----------------------------