nvbenjo 0.0.1__tar.gz

nvbenjo-0.0.1/.dockerignore

@@ -0,0 +1,16 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+.ruff_cache
+.venv
+.vscode
+build
+
+
+Dockerfile
+outputs

nvbenjo-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: release
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      
+      - name: Install the project with onnx
+        run: uv sync --extra onnx-cpu --dev
+
+      - name: Build
+        run: |
+          # This strips the 'v' from the tag (e.g., v1.0.0 -> 1.0.0)
+          TAG_NAME="${{ github.event.release.tag_name }}"
+          export SETUPTOOLS_SCM_PRETEND_VERSION="${TAG_NAME#v}"
+          uv build
+
+      - name: Publish package
+        run: uv publish

nvbenjo-0.0.1/.github/workflows/ruff.yml

@@ -0,0 +1,33 @@
+name: Ruff
+on: [push, pull_request]
+jobs:
+  ruff-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with: 
+          src: "./src/nvbenjo"
+
+  ruff-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: "format --check"
+          src: "./src/nvbenjo"
+
+  ty-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install the project
+        run: uv sync --extra onnx-cpu
+
+      - name: Run ty
+        run: uv run ty check .

nvbenjo-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      
+      - name: Install the project with onnx
+        run: uv sync --extra onnx-cpu
+      
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Install the project without onnx
+        run: uv sync
+      
+      - name: Run tests
+        run: uv run pytest

nvbenjo-0.0.1/.gitignore

@@ -0,0 +1,21 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+.coverage
+
+# Log files
+*.log
+
+# Virtual environments
+.venv
+
+# Hydra outputs
+nvbenjo/outputs
+outputs
+
+# Sphinx build files
+docs/_build/

nvbenjo-0.0.1/.python-version

@@ -0,0 +1 @@
+3.12

nvbenjo-0.0.1/.vscode/launch.json

@@ -0,0 +1,32 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "debug",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "nvbenjo.cli",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}",
+            "args": [
+                "-cn", "/home/lukas/Documents/git-repos/nvbenjo/src/nvbenjo/conf/onnxsilero.yaml"
+            ]
+        },
+        {
+            "name": "debug python test",
+            "type": "debugpy",
+            "request": "launch",
+            "justMyCode": true,
+            "console": "integratedTerminal",
+            "env": {},
+            "cwd": "${workspaceFolder}",
+            "module": "pytest",
+            "args": [
+                "tests/test_cli.py::test_cli_cn_path_arg"
+            ]
+        },
+    ]
+}

nvbenjo-0.0.1/Dockerfile

@@ -0,0 +1,26 @@
+FROM nvidia/cuda:12.8.1-devel-ubuntu22.04
+
+# Nvbandwith
+RUN apt-get update && apt-get install -y \
+    git \
+    cmake \
+    build-essential \
+    libboost-program-options-dev && \
+    rm -rf /var/lib/apt/lists/*
+
+RUN git clone https://github.com/NVIDIA/nvbandwidth.git
+WORKDIR /nvbandwidth
+RUN mkdir build && cd build && cmake .. && make
+ENV PATH="/nvbandwidth/build:$PATH"
+
+# get uv
+COPY --from=ghcr.io/astral-sh/uv:0.6.14 /uv /uvx /bin/
+ENV PATH="/root/.local/bin:${PATH}"
+
+# install nvbenjo
+RUN which uv
+COPY . /nvbenjo
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv tool install /nvbenjo
+
+CMD ["nvbenjo"]

nvbenjo-0.0.1/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 lukas-jkl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

nvbenjo-0.0.1/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: nvbenjo
+Version: 0.0.1
+Summary: Nvbenjo is a utility for benchmarking inference of deep learning models on NVIDIA GPUs.
+Author: lukas_jkl
+Requires-Python: <3.15,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torchvision
+Requires-Dist: torchaudio
+Requires-Dist: nvitop
+Requires-Dist: psutil
+Requires-Dist: py-cpuinfo
+Requires-Dist: hydra-core
+Requires-Dist: hydra_colorlog
+Requires-Dist: nvidia-ml-py
+Requires-Dist: pandas
+Requires-Dist: seaborn
+Requires-Dist: rich
+Provides-Extra: onnx-cpu
+Requires-Dist: onnx>=1.14.0; extra == "onnx-cpu"
+Requires-Dist: onnxruntime>=1.15.0; extra == "onnx-cpu"
+Provides-Extra: onnx-gpu
+Requires-Dist: onnx>=1.14.0; extra == "onnx-gpu"
+Requires-Dist: onnxruntime-gpu>=1.15.0; extra == "onnx-gpu"
+Dynamic: license-file
+
+# Nvbenjo
+
+[![Nox](https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg)](https://github.com/wntrblm/nox)
+![Ruff](https://github.com/lukas-jkl/nvbenjo/actions/workflows/ruff.yml/badge.svg)
+![Tests](https://github.com/lukas-jkl/nvbenjo/actions/workflows/test.yml/badge.svg)
+
+Nvbenjo is a utility for benchmarking inference of deep learning models on NVIDIA GPUs.
+It supports models in [Onnx](https://onnx.ai/) format as well as [PyTorch](https://pytorch.org/) models.
+
+## Usage
+
+```bash
+# Specify models to run in the command line
+nvbenjo \
+"+nvbenjo.models={\
+    efficientnet: {type_or_path: 'torchvision:efficientnet_b0',  shape:['B',3,224,224],  batch_sizes: [16,32]},\
+    resnet:       {type_or_path: 'torchvision:wide_resnet101_2', shape: ['B',3,224,224], batch_sizes: [16,32]}\
+}"
+
+# or better, specify your own config (or one of the pre-defined config files)
+nvbenjo -cn small
+nvbenjo -cn="/my/config/path/myconfig.yaml"
+
+# override single arguments of your config
+nvbenjo -cn="/my/config/path/myconfig.yaml" nvbenjo.models.mymodel.num_batches=10
+
+# show current config and help
+nvbenjo -cn="/my/config/path/myconfig.yaml" --help
+```
+
+## Development
+
+Example using uv:
+
+```bash
+uv sync --extra dev --extra onnx-cpu # or gpu
+uv run nvbenjo
+
+# for a quick run
+uv run nvbenjo -cn small
+
+# tests
+uv run pytest
+uv run nox
+```

nvbenjo-0.0.1/README.md

@@ -0,0 +1,45 @@
+# Nvbenjo
+
+[![Nox](https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg)](https://github.com/wntrblm/nox)
+![Ruff](https://github.com/lukas-jkl/nvbenjo/actions/workflows/ruff.yml/badge.svg)
+![Tests](https://github.com/lukas-jkl/nvbenjo/actions/workflows/test.yml/badge.svg)
+
+Nvbenjo is a utility for benchmarking inference of deep learning models on NVIDIA GPUs.
+It supports models in [Onnx](https://onnx.ai/) format as well as [PyTorch](https://pytorch.org/) models.
+
+## Usage
+
+```bash
+# Specify models to run in the command line
+nvbenjo \
+"+nvbenjo.models={\
+    efficientnet: {type_or_path: 'torchvision:efficientnet_b0',  shape:['B',3,224,224],  batch_sizes: [16,32]},\
+    resnet:       {type_or_path: 'torchvision:wide_resnet101_2', shape: ['B',3,224,224], batch_sizes: [16,32]}\
+}"
+
+# or better, specify your own config (or one of the pre-defined config files)
+nvbenjo -cn small
+nvbenjo -cn="/my/config/path/myconfig.yaml"
+
+# override single arguments of your config
+nvbenjo -cn="/my/config/path/myconfig.yaml" nvbenjo.models.mymodel.num_batches=10
+
+# show current config and help
+nvbenjo -cn="/my/config/path/myconfig.yaml" --help
+```
+
+## Development
+
+Example using uv:
+
+```bash
+uv sync --extra dev --extra onnx-cpu # or gpu
+uv run nvbenjo
+
+# for a quick run
+uv run nvbenjo -cn small
+
+# tests
+uv run pytest
+uv run nox
+```

nvbenjo-0.0.1/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

nvbenjo-0.0.1/docs/conf.py

@@ -0,0 +1,86 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+
+# Add the src directory to the path so Sphinx can find nvbenjo
+sys.path.insert(0, os.path.abspath("../src"))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Nvbenjo"
+copyright = "2025, lukas-jkl"
+author = "lukas-jkl"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",  # Auto-generate docs from docstrings
+    "sphinx.ext.napoleon",  # Support for NumPy/Google style docstrings
+    "sphinx.ext.viewcode",  # Add links to source code
+    "sphinx.ext.intersphinx",  # Link to other projects' documentation
+    "myst_parser",
+    "sphinx_copybutton",
+]
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+# Napoleon settings for better NumPy-style formatting
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = True
+napoleon_type_aliases = {
+    "TensorLike": "nvbenjo.utils.TensorLike",
+    "array_like": ":term:`array_like`",
+}
+napoleon_attr_annotations = True
+
+# Add NumPy intersphinx for better links
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "torch": ("https://pytorch.org/docs/stable/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "pandas": ("https://pandas.pydata.org/docs/", None),
+}
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "pydata_sphinx_theme"
+html_static_path = ["_static"]
+
+# PyData theme options
+html_theme_options = {
+    "github_url": "https://github.com/lukas-jkl/nvbenjo",
+    "show_nav_level": 2,
+    "navigation_depth": 3,
+    "show_toc_level": 2,
+}
+# Remove left sidebar (don't need it for now)
+html_sidebars = {"**": []}
+html_show_sourcelink = False
+html_copy_source = False
+
+# -- Options for autodoc extension -------------------------------------------
+autodoc_default_options = {
+    "member-order": "bysource",
+    "members": False,
+    "undoc-members": False,
+    "exclude-members": "__weakref__, __init__",
+    "inherited-members": False,
+}
+
+# Show type hints in signature only
+autodoc_typehints = "description"
+autodoc_typehints_format = "short"
+autodoc_class_signature = "mixed"

nvbenjo-0.0.1/docs/configuration.md

@@ -0,0 +1,34 @@
+# Configuration
+
+Nvbenjo uses [Hydra](https://hydra.cc/) for configuration using the dataclasses listed below. 
+
+## Main configuration classes
+
+```{eval-rst}
+.. autoclass:: nvbenjo.cfg.BenchConfig
+   :members:
+   
+.. autoclass:: nvbenjo.cfg.NvbenjoConfig
+   :members:
+```
+
+## Pytorch
+
+```{eval-rst}
+.. autoclass:: nvbenjo.cfg.TorchModelConfig
+   :members:
+
+.. autoclass:: nvbenjo.cfg.TorchRuntimeConfig
+   :members:
+
+```
+
+## Onnx
+
+```{eval-rst}
+.. autoclass:: nvbenjo.cfg.OnnxModelConfig
+   :members:
+   
+.. autoclass:: nvbenjo.cfg.OnnxRuntimeConfig
+   :members:
+```

nvbenjo-0.0.1/docs/examples.md

@@ -0,0 +1,41 @@
+# Examples
+
+
+```{eval-rst}
+.. literalinclude:: ../src/nvbenjo/conf/example.yaml
+   :language: yaml
+   :caption: Example Configuration
+```
+
+## Onnx
+
+```{eval-rst}
+.. literalinclude:: ../src/nvbenjo/conf/onnx.yaml
+   :language: yaml
+   :caption: Example Configuration of Onnx Model
+```
+
+```{eval-rst}
+.. literalinclude:: ../src/nvbenjo/conf/onnxsilero.yaml
+   :language: yaml
+   :caption: Example Configuration of Onnx-Silero Model
+```
+
+
+## PyTorch
+
+### Torchvision
+
+```{eval-rst}
+.. literalinclude:: ../src/nvbenjo/conf/torchvision.yaml
+   :language: yaml
+   :caption: Example Configuration of Torchvision Models
+```
+
+### Huggingface
+
+```{eval-rst}
+.. literalinclude:: ../src/nvbenjo/conf/huggingface.yaml
+   :language: yaml
+   :caption: Example Configuration of Huggingface Models
+```

nvbenjo-0.0.1/docs/index.md

@@ -0,0 +1,73 @@
+# Nvbenjo Documentation
+
+Nvbenjo is a utility for benchmarking inference of deep learning models on NVIDIA GPUs.
+It supports models in [Onnx](https://onnx.ai/) format as well as [PyTorch](https://pytorch.org/) models.
+
+```{toctree}
+:maxdepth: 2
+:caption: Contents
+
+self
+configuration
+python_api
+examples
+```
+
+(usage)=
+## Usage
+Nvbenjo can be used as command line tool and uses [hydra](https://hydra.cc/) configuration. 
+
+Specify configuration directly from the command line:
+```bash
+nvbenjo \
+"+nvbenjo.models={\
+    efficientnet: {type_or_path: 'torchvision:efficientnet_b0',  shape:['B',3,224,224],  batch_sizes: [16,32]},\
+    resnet:       {type_or_path: 'torchvision:wide_resnet101_2', shape: ['B',3,224,224], batch_sizes: [16,32]}\
+}"
+```
+
+### Usage with Config File
+
+Or better, specify your own config (or one of the pre-defined config files)
+```
+nvbenjo -cn small
+nvbenjo -cn="/my/config/path/myconfig.yaml"
+```
+
+Override single arguments of your config
+```
+nvbenjo -cn="/my/config/path/myconfig.yaml" nvbenjo.models.mymodel.num_batches=10
+```
+
+
+```{eval-rst}
+.. literalinclude:: ../src/nvbenjo/conf/example.yaml
+   :language: yaml
+   :caption: Example Configuration
+```
+
+### Usage with Python API
+
+See the [Python API Reference](python_api.md) for detailed documentation of all available functions and classes and [Configuration Reference](configuration.md) for config objects.
+
+
+```python
+from nvbenjo import cfg
+from nvbenjo.utils import PrecisionType
+from nvbenjo import benchmark
+
+
+model_cfg = cfg.TorchModelConfig(
+    name="torch-shufflenet-v2-x0-5",
+    type_or_path="torchvision:shufflenet_v2_x0_5",
+    shape=(("B", 3, 224, 224),),
+    devices=["cpu"],
+    batch_sizes=[1],
+    num_warmup_batches=1,
+    num_batches=2,
+    runtime_options={
+        "test1": cfg.TorchRuntimeConfig(compile=False, precision=PrecisionType.FP32),
+    },
+)
+results = benchmark.benchmark_models({"model_1": model_cfg})
+```

nvbenjo-0.0.1/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

nvbenjo-0.0.1/docs/python_api.md

@@ -0,0 +1,37 @@
+# Python API Reference
+
+## Benchmark Module
+
+```{eval-rst}
+.. autofunction:: nvbenjo.benchmark.benchmark_models
+
+.. autofunction:: nvbenjo.benchmark.load_model
+```
+
+## PyTorch Utilities
+
+```{eval-rst}
+.. autofunction:: nvbenjo.torch_utils.get_model
+
+.. autofunction:: nvbenjo.torch_utils.measure_memory_allocation
+
+.. autofunction:: nvbenjo.torch_utils.measure_repeated_inference_timing
+```
+
+## ONNX Utilities
+
+```{eval-rst}
+.. autofunction:: nvbenjo.onnx_utils.get_model
+
+.. autofunction:: nvbenjo.onnx_utils.measure_memory_allocation
+
+.. autofunction:: nvbenjo.onnx_utils.measure_repeated_inference_timing
+```
+
+## System Information
+
+```{eval-rst}
+.. autofunction:: nvbenjo.system_info.get_system_info
+
+.. autofunction:: nvbenjo.system_info.get_gpu_info
+```