mirror of
https://github.com/NVIDIA/nvbench.git
synced 2026-03-25 09:37:24 +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
99 lines
3.1 KiB
Python
99 lines
3.1 KiB
Python
# Copyright 2025 NVIDIA Corporation
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 with the LLVM exception
|
|
# (the "License"); you may not use this file except in compliance with
|
|
# the License.
|
|
#
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://llvm.org/foundation/relicensing/LICENSE.txt
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import importlib
|
|
import importlib.metadata
|
|
import warnings
|
|
|
|
try:
|
|
__version__ = importlib.metadata.version("cuda-bench")
|
|
except Exception as e:
|
|
__version__ = "0.0.0dev"
|
|
warnings.warn(
|
|
"Could not retrieve version of cuda-bench package dynamically from its metadata. "
|
|
f"Exception {e} was raised. "
|
|
f"Version is set to fall-back value '{__version__}' instead."
|
|
)
|
|
|
|
|
|
# Detect CUDA runtime version and load appropriate extension
|
|
def _get_cuda_major_version():
|
|
"""Detect the CUDA runtime major version."""
|
|
try:
|
|
import cuda.bindings
|
|
|
|
# Get CUDA version from cuda-bindings package version
|
|
# cuda-bindings version is in format like "12.9.1" or "13.0.0"
|
|
version_str = cuda.bindings.__version__
|
|
major = int(version_str.split(".")[0])
|
|
return major
|
|
except ImportError:
|
|
raise ImportError(
|
|
"cuda-bindings is required for runtime CUDA version detection. "
|
|
"Install with: pip install cuda-bench[cu12] or pip install cuda-bench[cu13]"
|
|
)
|
|
|
|
|
|
_cuda_major = _get_cuda_major_version()
|
|
_extra_name = f"cu{_cuda_major}"
|
|
_module_fullname = f"cuda.bench.{_extra_name}._nvbench"
|
|
|
|
try:
|
|
_nvbench_module = importlib.import_module(_module_fullname)
|
|
except ImportError as e:
|
|
raise ImportError(
|
|
f"No cuda-bench extension found for CUDA {_cuda_major}.x. "
|
|
f"This wheel may not include support for your CUDA version. "
|
|
f"Supported CUDA versions: 12, 13. "
|
|
f"Original error: {e}"
|
|
)
|
|
|
|
# Import and expose all public symbols from the CUDA-specific extension
|
|
Benchmark = _nvbench_module.Benchmark
|
|
CudaStream = _nvbench_module.CudaStream
|
|
Launch = _nvbench_module.Launch
|
|
NVBenchRuntimeError = _nvbench_module.NVBenchRuntimeError
|
|
State = _nvbench_module.State
|
|
register = _nvbench_module.register
|
|
run_all_benchmarks = _nvbench_module.run_all_benchmarks
|
|
_test_cpp_exception = _nvbench_module._test_cpp_exception
|
|
_test_py_exception = _nvbench_module._test_py_exception
|
|
|
|
# Expose the module as _nvbench for backward compatibility (e.g., for tests)
|
|
_nvbench = _nvbench_module
|
|
|
|
# Set module of exposed objects
|
|
Benchmark.__module__ = __name__
|
|
CudaStream.__module__ = __name__
|
|
Launch.__module__ = __name__
|
|
NVBenchRuntimeError.__module__ = __name__
|
|
State.__module__ = __name__
|
|
register.__module__ = __name__
|
|
run_all_benchmarks.__module__ = __name__
|
|
|
|
# Clean up internal symbols
|
|
del (
|
|
_nvbench_module,
|
|
_cuda_major,
|
|
_extra_name,
|
|
_module_fullname,
|
|
_get_cuda_major_version,
|
|
)
|
|
|
|
__doc__ = """
|
|
CUDA Kernel Benchmarking Library Python API
|
|
"""
|