Add WorkerCrashedError to cancel docs (#10534)

This commit is contained in:
Ian Rodney
2020-09-03 13:23:04 -07:00
committed by GitHub
parent 0c0b0d0a73
commit a13c83d7f0
+2 -1
View File
@@ -1612,7 +1612,8 @@ def cancel(object_ref, *, force=False):
Only non-actor tasks can be canceled. Canceled tasks will not be
retried (max_retries will not be respected).
Calling ray.get on a canceled task will raise a TaskCancelledError.
Calling ray.get on a canceled task will raise a TaskCancelledError or a
WorkerCrashedError if ``force=True``.
Args:
object_ref (ObjectRef): ObjectRef returned by the task