https://github.com/slowli/yab

Yet Another Benchmarking framework powered by `cachegrind`
https://github.com/slowli/yab

Last synced: about 1 month ago
JSON representation

Yet Another Benchmarking framework powered by `cachegrind`

• Host: GitHub
• URL: https://github.com/slowli/yab
• Owner: slowli
• License: apache-2.0
• Created: 2024-08-18T09:24:35.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-11-06T04:08:33.000Z (about 2 months ago)
• Last Synced: 2024-11-06T09:11:58.389Z (about 2 months ago)
• Language: Rust
• Size: 1.15 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Yet Another Benchmarking framework for Rust

[![CI](https://github.com/slowli/yab/actions/workflows/ci.yml/badge.svg)](https://github.com/slowli/yab/actions/workflows/ci.yml)

[![License: MIT OR Apache-2.0](https://img.shields.io/badge/License-MIT%2FApache--2.0-blue)](https://github.com/slowli/yab#license)

YAB is **Y**et **A**nother **B**enchmarking framework powered by [`cachegrind`] from the Valgrind tool suite.

It collects reproducible measurements of Rust code (e.g., the number of executed instructions,

number of L1 and L2/L3 cache hits and RAM accesses), making it possible to use in CI etc.

## Project overview

The project consists of the following crates:

- [`yab`](crates/yab): The benchmarking framework itself

- [`yab-e2e-tests`](e2e-tests): End-to-end tests for the framework.

## License

Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE)

or [MIT license](LICENSE-MIT) at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in `yab` by you, as defined in the Apache-2.0 license,

shall be dual licensed as above, without any additional terms or conditions.

[`cachegrind`]: https://valgrind.org/docs/manual/cg-manual.html