run_bm: Execute a benchmark run

In ursa-labs/arrowbench: Tools for Continuous and Interactive Benchmarking

Execute a benchmark run

Description

This is the function that gets called in the script that run_one() prepares. You may call this function interactively, but you won't get the isolation in a fresh R process that run_one() provides.

Usage

run_bm(
  bm,
  ...,
  n_iter = 1,
  batch_id = NULL,
  profiling = FALSE,
  global_params = list(),
  run_id = NULL,
  run_name = NULL,
  run_reason = NULL
)

Arguments

bm	Benchmark() object
...	parameters passed to bm$setup() or global parameters; see the "Parameterizing benchmarks" section of Benchmark()
n_iter	Integer number of iterations to replicate each benchmark
batch_id	a length 1 character vector to identify the batch
profiling	Logical: collect prof info? If TRUE, the result data will contain a prof_file field, which you can read in with profvis::profvis(prof_input = file). Default is FALSE
global_params	the global parameters that have been set
run_id	Unique ID for the run
run_name	Name for the run
run_reason	Low-cardinality reason for the run, e.g. "commit" or "test"

ursa-labs/arrowbench documentation built on July 8, 2023, 11:36 a.m.