Skip to main content

Static pre-flight checker for ONNX -> TensorRT conversion.

Project description

trtcheck

ci pypi python license

Static pre-flight checker for ONNX to TensorRT conversion.

trtcheck reads an ONNX file, runs five independent checkers against it, and tells you in seconds whether the model will convert cleanly to a TensorRT engine. If it won't, the report explains what to fix. It runs anywhere Python runs: no TensorRT, no CUDA driver, no GPU required.

trtcheck console output on a failing model

Why

The PyTorch -> ONNX -> TensorRT pipeline fails most of the time on the last hop. The errors are cryptic and the iteration loop ("export, wait two minutes, read a C++ traceback, google, try again") burns hours per fix.

trtcheck predicts the failure modes locally so you can correct them before invoking trtexec.

Install

pip install trtcheck

Or from source:

git clone https://github.com/sohams25/trtcheck.git
cd trtcheck
pip install -e ".[dev]"

Requires Python 3.10+.

Usage

# Basic check (defaults to TensorRT 10.3)
trtcheck model.onnx

# Target a specific TensorRT version
trtcheck model.onnx --target-trt 8.6

# Machine-readable output for CI
trtcheck model.onnx --format json --output report.json

# Self-contained HTML report
trtcheck model.onnx --format html --output report.html

# Filter to blockers only
trtcheck model.onnx --severity critical

# Compare two versions of a model (before/after a fix)
trtcheck before.onnx after.onnx --diff

# Auto-fix simple issues (INT64 indices, UINT8 inputs followed by Cast)
trtcheck model.onnx --fix --dry-run --output model_fixed.onnx
trtcheck model.onnx --fix --output model_fixed.onnx

Exit code is 1 if conversion is unlikely to succeed, 0 otherwise. Wire that into CI to catch regressions at PR time.

What it checks

Checker Catches
operator support Ops missing or partial in the target TRT version (e.g. SequenceEmpty, GroupNormalization on TRT 8.x)
precision UINT8/FLOAT64/STRING inputs, INT64 weights, BF16 on older targets
dynamic shapes Multiple symbolic dims on inputs
control flow Loop with runtime trip count, nested Loop, If, Scan
graph structure Empty outputs, duplicate node names, oversized constants

Each finding includes a specific remediation, not just "this is bad."

How the operator matrix is maintained

The TRT-version-to-operator support table lives in trtcheck/data/operator_matrix.json and is hand curated. To refresh it for a new TensorRT release:

  1. Edit tools/build_operator_matrix.py (the source of truth).
  2. Run python tools/build_operator_matrix.py to regenerate the JSON.
  3. Run the test suite: pytest tests/test_data_files.py -v.
  4. Commit both the script change and the regenerated JSON.

Checking drift against upstream

tools/check_matrix_drift.py fetches the official ONNX-TensorRT operators.md from GitHub and flags any drift against our bundled matrix:

python tools/check_matrix_drift.py                   # online fetch
python tools/check_matrix_drift.py --local docs.md   # offline file
python tools/check_matrix_drift.py --target 10.0     # different TRT col

Exit code 1 (with a line-per-drift summary) when drift is detected, 0 when the matrix is in sync. Run it before cutting a release to keep the matrix honest.

Development

# Set up
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

# Tests
./scripts/run-tests.sh

# Type check
mypy trtcheck/

# Format
black . && isort .

If you contribute a new checker, follow the TDD cycle: write the test first, confirm it fails, then implement. See CLAUDE.md for the full project conventions.

Roadmap

  • HTML diff view with side-by-side columns.
  • Quarterly refresh tooling driven by NVIDIA release notes.

See CHANGELOG.md for release notes.

License

MIT. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trtcheck-0.3.0.tar.gz (46.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

trtcheck-0.3.0-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

Details for the file trtcheck-0.3.0.tar.gz.

File metadata

  • Download URL: trtcheck-0.3.0.tar.gz
  • Upload date:
  • Size: 46.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for trtcheck-0.3.0.tar.gz
Algorithm Hash digest
SHA256 51c0787af43b045ada25db4a400470de35e62ea5d44320361e9852fb322d1794
MD5 51b351c5d95b5392a8134a2bc32aa5cf
BLAKE2b-256 2ab7f2bcdd2aa771c2ca68d0e66b0fb9a339e9e71918e277b92ed55cab6a8e48

See more details on using hashes here.

Provenance

The following attestation bundles were made for trtcheck-0.3.0.tar.gz:

Publisher: release.yml on sohams25/trtcheck

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file trtcheck-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: trtcheck-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 37.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for trtcheck-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17ee06d25af873c277f11d6c9413a7c181a9f23fa3cd1c802874610e289a49fc
MD5 d0d0d21f61ca7c43ad66856232b18e5b
BLAKE2b-256 0f3f8f941c8dca38be8ef35f364e45203c539efa824b01255970ab144dccad49

See more details on using hashes here.

Provenance

The following attestation bundles were made for trtcheck-0.3.0-py3-none-any.whl:

Publisher: release.yml on sohams25/trtcheck

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page