This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
Fix exception handling api doc #13519
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nswamy
reviewed
Dec 7, 2018
| @@ -157,6 +157,11 @@ def waitall(): | |||
| """Wait for all async operations to finish in MXNet. | |||
|
|
|||
| This function is used for benchmarking only. | |||
There was a problem hiding this comment.
Not many people will understand what Rethrowing exception means. I suggest the below:
. warning:: This API is for internal purpose for benchmarking) , it does not do any error handling and can cause silent failures. Use it only if you are confident that your code error free, suggested to call wait_to_read on all outputs after waitall.
nswamy
added
Unclear Error/Doc
Doc
pr-awaiting-response
aaronmarkham
suggested changes
Dec 7, 2018
There was a problem hiding this comment.
Adjusting Naveen's comment.
Please also test this with make html USE_OPENMP=1 SPHINXOPTS=-W to make sure the special warning syntax is formatted correctly. For example, my suggestion may merge without a line break after that warning block and that could be a problem...
Co-Authored-By: anirudh2290 <anirudh2290@apache.org>
anirudh2290
force-pushed
the
fix_exception_handling_doc
branch
from
bca9abc to
5e4ef0d
Compare
|
Thanks @aaronmarkham @nswamy . Updated the API doc. |
zhaoyao73
pushed a commit
to zhaoyao73/incubator-mxnet
that referenced
this pull request
Dec 13, 2018
* Fix exception handling api doc * Update waitall api doc Co-Authored-By: anirudh2290 <anirudh2290@apache.org>
zhaoyao73
added a commit
to zhaoyao73/incubator-mxnet
that referenced
this pull request
Dec 13, 2018
* upstream/master: (54 commits) Add notes about debug with libstdc++ symbols (apache#13533) add cpp example inception to nightly test (apache#13534) Fix exception handling api doc (apache#13519) fix link for gluon model zoo (apache#13583) ONNX import/export: Size (apache#13112) Update MXNetTutorialTemplate.ipynb (apache#13568) fix the situation where idx didn't align with rec (apache#13550) Fix use-before-assignment in convert_dot (apache#13511) License update (apache#13565) Update version to v1.5.0 including clojure package (apache#13566) Fix flaky test test_random:test_randint_generator (apache#13498) Add workspace cleaning after job finished (apache#13490) Adding test for softmaxoutput (apache#13116) apache#13441 [Clojure] Add Spec Validations for the Random namespace (apache#13523) Revert "Bumped minor version from 1.4.0 to 1.5.0 on master, updated License file" (apache#13558) Chi_square_check for discrete distribution fix (apache#13543) Updated docs for randint operator (apache#13541) Simplifications and some fun stuff for the MNIST Gluon tutorial (apache#13094) Fix apache#13521 (apache#13537) Add a retry to qemu_provision (apache#13551) ...
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There were some issues with MXNet users because of not being aware of waitall not rethrowing exceptions. It was documented as a limitation in exception handling doc here: https://mxnet.incubator.apache.org/architecture/exception_handling.html?highlight=exception#limitation but not in the API doc.
Adding it to the API doc.
Checklist
Essentials
Please feel free to remove inapplicable items for your PR.
Changes