Equip python functions, classes, methods and exceptions with docstrings #294
+945
−573
Conversation
This file contains hidden or 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
…it, runner loop is stopped and other pending benchmark instances are skipped
Add try/catch around Python calls to improve keyboard interrup response.
This reverts commit c286199.
These methods take reference to a boolean whose value signals whether benchmark instances pending for execution are to be skipped. void benchmark->run_or_skip(bool &) is called by Python to ensure that KeyboardInterrupt is properly handled in scripts that contain multiple benchmarks, or in case when single benchmark script is executed on a machine with more than one device.
This loop uses benchmark.run_or_skip to resolve NVIDIA#284 even for scripts that contain more than one benchmark, or when a script with a single benchmark is executed when more than one device is available.
…exception, on others benchmakr is to continue execution
Added tests that docstrings exist and are not empty. This closes NVIDIA#291
oleksandr-pavlyk
changed the title
Use py::gil_safe_call_once_and_store facility pybind11 provides.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR builds on top of #290. Hence, it should be merged after #290 has been merged.
This PR moves doc-strings for Python objects exposed in
cuda.benchnamespace from__init__.pyito implementation file, making doc-strings interactively available to the user. For example,help(cuda.bench.State)would not include doc-strings of the class itself as well as of its methods.Closes #291