Reinstate recursion limit CLI option

This commit adds a CLI option for setting
the recursion limit. This option was originally
removed because it was considered unnecessary,
but in some cases of very large (enormous) networks,
a RecursionError is encountered during graph traversal.
A simple solution for issues like those is to manually
increase the recursion limit.

Signed-off-by: Dwight Lidman <dwight.lidman@arm.com>
Change-Id: Id0dbf68edf59b151abfa91783b5f8f021c1bb40f

1 files changed, 16 insertions, 0 deletions

diff --git a/OPTIONS.md b/OPTIONS.md
index 2420bbfe..6673ba5e 100644
--- a/OPTIONS.md
+++ b/OPTIONS.md
@@ -223,6 +223,22 @@ be a power of two and greater or equal to 16.
 vela network.tflite --allocation-alignment 128
 ```
 
+### Recursion Limit
+
+Sets the Python internal limit to depth of recursion. It may be
+necessary to increase this from the default for very large networks
+due to the recursive nature of the graph traversal algorithm.
+If Vela fails with a `RecursionError`, try increasing the limit using
+this option to see if it resolves the issue.  
+Please note that this option may not work as intended on Microsoft Windows
+systems, as there is a hard limit on thread stack size.  
+**Type: Integer**  
+**Default: 1000**
+
+```bash
+vela network.tflite --recursion-limit 2000
+```
+
 ## Verbose Print Options
 
 All of the options below are disabled by default and enabling them will add