nswamy closed pull request #13519: Fix exception handling api doc
URL: https://github.com/apache/incubator-mxnet/pull/13519
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/python/mxnet/ndarray/ndarray.py b/python/mxnet/ndarray/ndarray.py
index 78ec0b91f88..4e6d0cdc929 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())
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
