Function plot

darts/utils/_plotting.py:177–349

Plot a TimeSeries using Matplotlib. Parameters ---------- series The TimeSeries to plot. new_plot Whether to spawn a new axis to plot on. See also parameter `ax`. central_quantile The quantile (between 0 and 1) to plot as a "central" value, if the series

(
    series: TimeSeries,
    new_plot: bool = False,
    central_quantile: float | str = 0.5,
    low_quantile: float | None = 0.05,
    high_quantile: float | None = 0.95,
    default_formatting: bool = True,
    title: str | None = None,
    label: str | Sequence[str] | None = "",
    max_nr_components: int = 10,
    ax: matplotlib.axes.Axes | None = None,
    alpha: float | None = None,
    color: str | tuple | Sequence[str, tuple] | None = None,
    c: str | tuple | Sequence[str, tuple] | None = None,
    *args,
    **kwargs,
)

def plot(
    series: TimeSeries,
    new_plot: bool = False,
    central_quantile: float | str = 0.5,
    low_quantile: float | None = 0.05,
    high_quantile: float | None = 0.95,
    default_formatting: bool = True,
    title: str | None = None,
    label: str | Sequence[str] | None = "",
    max_nr_components: int = 10,
    ax: matplotlib.axes.Axes | None = None,
    alpha: float | None = None,
    color: str | tuple | Sequence[str, tuple] | None = None,
    c: str | tuple | Sequence[str, tuple] | None = None,
    *args,
    **kwargs,
) -> matplotlib.axes.Axes:
    """Plot a TimeSeries using Matplotlib.

    Parameters
    ----------
    series
        The TimeSeries to plot.
    new_plot
        Whether to spawn a new axis to plot on. See also parameter `ax`.
    central_quantile
        The quantile (between 0 and 1) to plot as a "central" value, if the series is stochastic (i.e., if
        it has multiple samples). This will be applied on each component separately (i.e., to display quantiles
        of the components' marginal distributions). For instance, setting `central_quantile=0.5` will plot the
        median of each component. `central_quantile` can also be set to 'mean'.
    low_quantile
        The quantile to use for the lower bound of the plotted confidence interval. Similar to `central_quantile`,
        this is applied to each component separately (i.e., displaying marginal distributions). No confidence
        interval is shown if `low_quantile` is None (default 0.05).
    high_quantile
        The quantile to use for the upper bound of the plotted confidence interval. Similar to `central_quantile`,
        this is applied to each component separately (i.e., displaying marginal distributions). No confidence
        interval is shown if `high_quantile` is None (default 0.95).
    default_formatting
        Whether to use the darts default scheme.
    title
        Optionally, a plot title.
    label
        Can either be a string or list of strings. If a string and the series only has a single component, it is
        used as the label for that component. If a string and the series has multiple components, it is used as
        a prefix for each component name. If a list of strings with length equal to the number of components in
        the series, the labels will be mapped to the components in order.
    max_nr_components
        The maximum number of components of a series to plot. -1 means all components will be plotted.
    ax
        Optionally, an axis to plot on. If `None`, and `new_plot=False`, will use the current axis. If
        `new_plot=True`, will create a new axis.
    alpha
        Optionally, set the line alpha for deterministic series, or the confidence interval alpha for
        probabilistic series.
    color
        Can either be a single color or list of colors. Any matplotlib color is accepted (string, hex string,
        RGB/RGBA tuple). If a single color and the series only has a single component, it is used as the color