API

This page describes the public API of pyquickbench.

Benchmarks

The two main functions of pyquickbench.

run_benchmark	Runs a full benchmark.
plot_benchmark	Plots benchmarks results

Time Train

Provides rudimentary profiling features to be used with pyquickbench.

TimeTrain	Records elapsed time between interest points in code
TimeTrain.toc	Records a new wagon in the TimeTrain
TimeTrain.to_dict	Returns time measurements within a TimeTrain as a Python dictionnary

Constants

A few named constants and default values in pyquickbench.

default_ax_name	The default value for benchmarked functions arguments.
fun_ax_name	The axis name for functions to be benchmarked.
repeat_ax_name	The axis name for reapeated benchmarks.
out_ax_name	The axis name for function output.
all_reductions	Available data reductions.
all_plot_intents	Available plot intents.
all_transforms	Available data transformations.