Module type Benchmark.S

The module type of benchmarks

include Benchmark_base
val name : Namespace.t

Name of the benchmark

val info : string

Description of the benchmark

val module_filename : string

File where the benchmark module is defined

val purpose : purpose

Described the purpose of the benchmark. * Generate_code of destination: generates code at the given destination file. * Other_purpose of purpose: any other purpose. The goal is to explain why the function is benchmarked since it does not produce a cost function.

val tags : string list

Tags of the benchmark

type config

Configuration of the benchmark (eg sampling parameters, paths, etc)

val default_config : config

Default configuration of the benchmark

val config_encoding : config Mavryk_base.TzPervasives.Data_encoding.t

Configuration encoding

type workload

Benchmark workload

val workload_encoding : workload Mavryk_base.TzPervasives.Data_encoding.t

Workload encoding

val workload_to_vector : workload -> Sparse_vec.String.t

Optional conversion to vector, for report generation purposes

val models : (string * workload Model.t) list

Cost models, with a given local name (string) for reference

val create_benchmarks : rng_state:Stdlib.Random.State.t -> bench_num:int -> config -> (unit -> workload Generator.benchmark) list

Benchmark generator