sierra.core.graphs.summary_line#

Linegraph for summarizing the results of a Batch Experiment.

Graphs one datapoint per Experiment.

Functions#

generate(→ bool)

Generate a linegraph from a Batch Summary Data file.

Module Contents#

sierra.core.graphs.summary_line.generate(pathset: generate.pathset, input_stem: str, output_stem: str, medium: str, title: str, xlabel: str, ylabel: str, backend: str, legend: list[str], xticks: list[float], stats_center: str, stats_spread: str, *, xticklabels: list[str] | None = None, large_text: bool = False, logyscale: bool = False) → bool[source]#

Generate a linegraph from a Batch Summary Data file.

Possibly shows the 95% confidence interval or box and whisker plots, according to configuration.

sierra.core.graphs.summary_line.paths#: Set of run-time tree paths for the batch experiment.

sierra.core.graphs.summary_line.input_stem#: Stem of the Batch Summary Data file to generate a graph from.

sierra.core.graphs.summary_line.output_fpath#: The absolute path to the output image file to save generated graph to.

sierra.core.graphs.summary_line.title#: Graph title.

sierra.core.graphs.summary_line.xlabel#: X-label for graph.

sierra.core.graphs.summary_line.ylabel#: Y-label for graph.

sierra.core.graphs.summary_line.backend#: The holoviews backend to use.

sierra.core.graphs.summary_line.xticks#: The xticks for the graph.

sierra.core.graphs.summary_line.xticklabels#: The xtick labels for the graph (can be different than the xticks; e.g., if the xticxs are 1-10 for categorical data, then then labels would be the categories).

sierra.core.graphs.summary_line.large_text#: Should the labels, ticks, and titles be large, or regular size?

sierra.core.graphs.summary_line.legend#: Legend for graph.

sierra.core.graphs.summary_line.logyscale#: Should the Y axis be in the log2 domain ?

sierra.core.graphs.summary_line.stats_spread#: The type of spread statistics to include on the graph (from --spread).

sierra.core.graphs.summary_line.stats_center#: The measure of centeral tendency to use as the main data input. (from --center).

sierra.core.graphs.summary_line.model_root#: The absolute path to the models/ directory for the batch experiment.