Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Commit

Permalink
Update waitall api doc
Browse files Browse the repository at this point in the history
Co-Authored-By: anirudh2290 <[email protected]>
  • Loading branch information
aaronmarkham and anirudh2290 authored Dec 7, 2018
1 parent 5c1a1ca commit bca9abc
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion python/mxnet/ndarray/ndarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +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.
. 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.
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
Expand Down

0 comments on commit bca9abc

Please sign in to comment.