From 2266d87d19416fd0c3d6b7a3e8812fdf7fa8a924 Mon Sep 17 00:00:00 2001 From: Anirudh Subramanian Date: Fri, 7 Dec 2018 19:46:57 -0800 Subject: [PATCH] Fix exception handling api doc (#13519) * Fix exception handling api doc * Update waitall api doc Co-Authored-By: anirudh2290 --- python/mxnet/ndarray/ndarray.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/python/mxnet/ndarray/ndarray.py b/python/mxnet/ndarray/ndarray.py index 78ec0b91f88d..4e6d0cdc929f 100644 --- 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. + .. warning:: + If your code has exceptions, `waitall` can cause silent failures. + For this reason you should avoid `waitall` in your code. + Use it only if you are confident that your code is error free. + Then make sure you call `wait_to_read` on all outputs after `waitall`. """ check_call(_LIB.MXNDArrayWaitAll())