mirror of
https://github.com/NVIDIA/nvbench.git
synced 2026-04-19 14:28:53 +00:00
807917cf54
Add sphinx-combined folder that builds combined C++ & Python docs Fixed relative text alignment in docstrings to fix autodoc warnigns Renamed cuda.bench.test_cpp_exception and cuda.bench.test_py_exception functions to start with underscore, signaling that these functions are internal and should not be documented Account for test_cpp_exceptions -> _test_cpp_exception, same for *_py_* Fix cpp_benchmarks, add py_benchmarks 1. Fixed xrefs in docs/sphinx-combined/cpp_benchmarks.md, which is built on top of docs/benchmarks.md Added level-1 heading, and pushed existing headings one level down. 2. Added py_benchmarks.md to document benchmarking of Python scripts. 3. Rearranged entries in index.rst so that overview documents come before API enumeration. Make sure to reset __module__ of reexported symbols to be cuda.bench Enumerate free functions in nvbench:: namespace Tweak to index.rst intro sentence and title Changed title, fixed references, added intro borrowed from README Fix punctuation in one of the itemlist item text Hide TOC from the index page. It is too long and confusing
18 lines
421 B
ReStructuredText
18 lines
421 B
ReStructuredText
`cuda.bench` Python API Reference
|
|
=================================
|
|
|
|
Python package ``cuda.bench`` is designed to empower
|
|
users to write CUDA kernel benchmarks in Python.
|
|
|
|
Alignment with behavior of benchmarks written in C++
|
|
allows for meaningful comparison between them.
|
|
|
|
Classes and functions
|
|
---------------------
|
|
|
|
.. automodule:: cuda.bench
|
|
:members:
|
|
:imported-members:
|
|
:undoc-members:
|
|
:show-inheritance:
|