Skip to content

Installation Guide

TrustBench is designed with a lightweight, framework-independent core. You only install the dependencies required for your specific frameworks and workloads.

Prerequisites

  • Python: >= 3.11
  • Package Manager: pip or uv
  • OS: Linux, macOS, or Windows

1. Core Installation

To install TrustBench with base dependencies (NumPy, SciPy, Scikit-learn, Pydantic, PyYAML, Click, Jinja2):

pip install trustbench

The core installation includes complete tabular evaluation (classification, regression), evaluation engine, and CLI tools.


2. Optional Dependency Groups

Install framework and feature bundles depending on your requirements:

Extra Command Included Functionality
PyTorch pip install "trustbench[pytorch]" PyTorch model adapter, torchvision datasets, GPU device transfers
ONNX Runtime pip install "trustbench[onnx]" ONNX session execution (onnxruntime) on CPU or CUDA
TensorFlow pip install "trustbench[tensorflow]" Keras and TensorFlow model adapters
JAX pip install "trustbench[jax]" JAX/Flax functional inference adapters
Storage pip install "trustbench[storage]" SQLite/PostgreSQL persistence (sqlalchemy)
API pip install "trustbench[api]" FastAPI REST server and uvicorn runner
Reporting pip install "trustbench[reporting]" Interactive Plotly HTML reporting and diagnostic charts
Everything pip install "trustbench[all]" Installs all optional frameworks and extras

3. Verifying Installation

Verify the CLI is installed and check the version:

trustbench version
Expected output:
trustbench 0.2.0

Verify Python imports:

import trustbench
print(trustbench.__version__)