get_default_parameters: Generate a dataframe of default parameters for a benchmark

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

Generate a dataframe of default parameters for a benchmark

Description

Generates a dataframe of parameter combinations for a benchmark to try based on the parameter defaults of its setup function and supplied parameters.

Usage

get_default_parameters(x, ...)

## Default S3 method:
get_default_parameters(x, ...)

## S3 method for class 'Benchmark'
get_default_parameters(x, ...)

## S3 method for class 'BenchmarkDataFrame'
get_default_parameters(x, ...)

Arguments

x	An object for which to generate parameters
...	Named arguments corresponding to the parameters of bm's setup function. May also contain global params cpu_count, lib_path, mem_alloc, and drop_caches. See the "Parameterizing benchmarks" section of Benchmark() for more details.

Value

For get_default_parameters.Benchmark, a dataframe of parameter combinations to try with a column for each parameter and a row for each combination.

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