Change retry error from RuntimeError to FlyteRecoverableException (#5128

) * Change retry error from RuntimeError to FlyteRecoverableException Signed-off-by: Daniel Sola <[email protected]> * add fault-tolerance header Signed-off-by: Daniel Sola <[email protected]> * add blank line Signed-off-by: Daniel Sola <[email protected]> --------- Signed-off-by: Daniel Sola <[email protected]> Co-authored-by: Daniel Sola <[email protected]>
flyteorg · Mar 28, 2024 · c61d976 · c61d976
1 parent d4929cf
commit c61d976
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/concepts/tasks.rst b/docs/concepts/tasks.rst
@@ -71,6 +71,8 @@ types in the system. Flyte has a set of defined, battle-tested task types. It al
 Inherent Features
 -----------------
 
+.. _fault-tolerance:
+
 Fault tolerance
 ^^^^^^^^^^^^^^^
 

diff --git a/docs/flyte_fundamentals/optimizing_tasks.md b/docs/flyte_fundamentals/optimizing_tasks.md
@@ -66,12 +66,13 @@ import random
 @task(retries=3)
 def compute_mean(data: List[float]) -> float:
     if random() < 0.05:
-        raise RuntimeError("Something bad happened 🔥")
+        raise FlyteRecoverableException("Something bad happened 🔥")
     return sum(data) / len(data)
 ```
 
 ```{note}
-Retries only take effect when running a task on a Flyte cluster.
+Retries only take effect when running a task on a Flyte cluster. 
+See {ref}`Fault Tolerance <fault-tolerance>` for details on the types of errors that will be retried.
 ```
 
 ## Timeouts