Fix exception handling api doc

apache · Dec 3, 2018 · 5c1a1ca · 5c1a1ca
1 parent 8949989
commit 5c1a1ca
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/python/mxnet/ndarray/ndarray.py b/python/mxnet/ndarray/ndarray.py
@@ -157,6 +157,11 @@ def waitall():
     """Wait for all async operations to finish in MXNet.
 
     This function is used for benchmarking only.
+    Rethrowing exceptions as part of mx.nd.waitall is not supported.
+    If your code has exceptions, waitall can cause silent failures.
+    Avoid waitall in your code/precede it with wait_to_read for the outputs
+    unless you are confident about your code not throwing an exception in
+    any scenario.
     """
     check_call(_LIB.MXNDArrayWaitAll())