benchmarking package

Subpackages

Submodules

benchmarking.evaluate module

benchmarking.evaluate.evaluate(function_name: str, *args: Any, **kwargs: Any) → float[source]

Helper function to evaluate different benchmarking functions given the function name. This helps to not have to put this large if-elif statement everywhere that multiple functions are possible.

Parameters:

function_name (str) – Name of the function to use. This must exactly match the actual function name.
*args – Positional arguments to be passed to the benchmarking function.
**kwargs – Keyword arguments to be passed to the benchmarking function.

Raises:

ValueError – Invalid function name was provided.

benchmarking.function_data module

benchmarking.function_data.function_data(function_name: str) → Dict[str, Any][source]

Helper function to retrieve function metadata based on function name.

Parameters:: function_name (str) – Name of the function to use. This must exactly match the actual function name.
Raises:: ValueError – Invalid function name was provided.
Returns:
Return type:: Dict[str, Any]

benchmarking package

Subpackages

Submodules

benchmarking.evaluate module

benchmarking.function_data module

benchmarking.function_ids module

Module contents