Construct an MsBenchmark object

Builds and validates an [MsBenchmark]. Create specs with [ms_benchmark_grid()], execute with [ms_run_benchmark()], store via `ms_benchmark()` – the trio stays three separate functions by the U-M7-04 ergonomics ruling (no generic merge).

Usage

ms_benchmark(results, settings = list())

Arguments

results

data.frame with the score columns described above.

settings

named list of benchmark settings.

Value

An [MsBenchmark] object.

See also

Other benchmark: ms_benchmark_grid(), ms_run_benchmark()

Examples

results <- data.frame(
  .engine = c("e1", "e2"), .scenario = c("sc1", "sc1"),
  .metric = c("f1", "f1"), .estimate = c(0.9, 0.7)
)
ms_benchmark(results, settings = list(seed = 1))
#> <MsBenchmark> 2 results