From a13c83d7f09a21df29b6b0221a96abf13a990fdd Mon Sep 17 00:00:00 2001 From: Ian Rodney Date: Thu, 3 Sep 2020 13:23:04 -0700 Subject: [PATCH] Add WorkerCrashedError to cancel docs (#10534) --- python/ray/worker.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/python/ray/worker.py b/python/ray/worker.py index 4eca2b338..1bc328216 100644 --- a/python/ray/worker.py +++ b/python/ray/worker.py @@ -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