You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by ns...@apache.org on 2018/12/12 01:22:22 UTC
[incubator-mxnet] branch master updated: Fix warning in waitall doc
(#13618)
This is an automated email from the ASF dual-hosted git repository.
nswamy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git
The following commit(s) were added to refs/heads/master by this push:
new 9ce7eab Fix warning in waitall doc (#13618)
9ce7eab is described below
commit 9ce7eabcbc9575128240f71f79f9f7cce1a19aa7
Author: Anirudh Subramanian <an...@apache.org>
AuthorDate: Tue Dec 11 17:22:02 2018 -0800
Fix warning in waitall doc (#13618)
---
python/mxnet/ndarray/ndarray.py | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/python/mxnet/ndarray/ndarray.py b/python/mxnet/ndarray/ndarray.py
index 4e6d0cd..9a62620 100644
--- a/python/mxnet/ndarray/ndarray.py
+++ b/python/mxnet/ndarray/ndarray.py
@@ -157,11 +157,13 @@ 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`.
+
+ 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())