HyperBench

About the project

WIP

Getting started

Prerequisites

WIP

Installation

WIP

Usage

Contributing

See CONTRIBUTING.md for details on contributing to the project.

Build

To build the project, run:

make

Linter and type checker

Use Ruff for linting and formatting:

make lint

Use Ty for type checking:

make typecheck

Use the check target to run both linter and type checker:

make check

Tests

Use pytest to run the test suite:

make test

# Run tests with HTML report
uv run pytest --cov=hyperbench --cov-report=html

Pre-commit hooks

Run the following command to install the pre-commit hook:

make setup

pre-commit install --config .github/hooks/.pre-commit-config.yaml --hook-type pre-commit --install-hooks --overwrite

License

WIP

Contact

WIP