Visualization

Functions to help visualize Benchmarks and their inputs.

graphviz_inputs_to_benchmarks(input_dataset_list: list[InputDataset], benchmark_list: list[Benchmark], file_length: int = 20) → Digraph

Generate a graphviz diagram mapping InputDataSets to MetricsStores via benchmarks.

The output will display automatically in a Jupyter Notebook, or can be saved to a file by calling the render() method of the Digraph.

Parameters:

input_dataset_list: list[InputDataset]

List of InputDatasets the user will pass to each Benchmark’s generate_metrics method.

benchmark_list: list[Benchmark]:

Which benchmarks will process the InputDatasets.

file_length: int

Max length of the filenames in the InputDataset. The last N characters of the filename will be retained, and the rest truncated.

Returns:

graphviz.Digraph:

graph that can be displayed or rendered.