module visualization.plot

Standard Line Plot.

This function returns a line plot using the style and coloring of the float framework.

Copyright (C) 2022 Johannes Haug.

function plot

plot(
    measures: List[list],
    legend_labels: List[str],
    y_label: str,
    fig_size: tuple = (13, 5),
    font_size: int = 16,
    x_label: str = 'Time Step $t$',
    variance_measures: Optional[List[list]] = None
) → Axes

Returns a line plot.

Each list provided in the measures attribute is displayed as one line.

Args:

  • measures: A list of lists, where each list corresponds to a series of measurements.
  • legend_labels: Labels for each list of measurements. These labels will be used in the legend.
  • y_label: The y-axis label text (e.g. the name of the performance measure that is displayed).
  • fig_size: The figure size (length x height)
  • font_size: The font size of the axis labels.
  • x_label: The x-axis label text. This defaults to 'Time Step t'.
  • variance_measures: Optionally, one can depict variances (as shaded areas around the line plot). This parameter must have the same dimensionality as 'measures'.

Returns:

  • Axes: The Axes object containing the line plot.

This file was automatically generated via lazydocs.