setup_benchmark

pyapprox.benchmarks.setup_benchmark(name, **kwargs)[source]

Setup a PyApprox benchmark.

Parameters:
namestring

The name of the benchmark

kwargs: kwargs

optional keyword arguments

Returns:
benchmarkBenchmark

Object containing the benchmark attributes

The benchmark object must contain at least the following two attributes
funcallable

A function with signature

fun(samples) -> np.ndarray(nsamples, nqoi)

where samples : np.ndarray(nvars, nsamples)

variableJointVariable

Class containing information about each of the nvars inputs to fun