2024-10-04 01:36:32 +00:00
|
|
|
## `cuprate-benchmark-lib`
|
2024-10-09 21:23:32 +00:00
|
|
|
This crate is the glue between
|
|
|
|
|
[`cuprate-benchmark`](https://github.com/Cuprate/cuprate/tree/benches/benches/benchmark/bin)
|
|
|
|
|
and all the benchmark crates.
|
|
|
|
|
|
2024-10-09 23:46:13 +00:00
|
|
|
It defines the [`crate::Benchmark`] trait, which is the behavior of all benchmarks.
|
2024-10-09 21:23:32 +00:00
|
|
|
|
|
|
|
|
See the [`cuprate-benchmark-example`](https://github.com/Cuprate/cuprate/tree/benches/benches/benchmark/example)
|
|
|
|
|
crate to see an example implementation of this trait.
|
|
|
|
|
|
|
|
|
|
After implementing this trait, a few steps must
|
|
|
|
|
be done such that the `cuprate-benchmark` binary
|
|
|
|
|
can actually run your benchmark crate; see the
|
|
|
|
|
[`Benchmarking` section in the Architecture book](https://architecture.cuprate.org/benchmarking/intro.html)
|
|
|
|
|
to see how to do this.
|
