Skip to content

plot_series

method plot_series(rows=('train', 'test'), columns=None, title=None, legend="upper left", figsize=(900, 600), filename=None, display=True)[source]

Plot a data series.

This plot is only available for forecast tasks.

Parameters rows: str, sequence or dict, default=("train", "test")
Selection of rows to plot.

  • If str: Name of the data set to plot.
  • If sequence: Names of the data sets to plot.
  • If dict: Names of the sets with corresponding selection of rows as values.

columns: int, str, segment, sequence, dataframe or None, default=None
Columns to plot. If None, all target columns are selected.

title: str, dict or None, default=None
Title for the plot.

legend: str, dict or None, default="upper left"
Legend for the plot. See the user guide for an extended description of the choices.

  • If None: No legend is shown.
  • If str: Position to display the legend.
  • If dict: Legend configuration.

figsize: tuple, default=(900, 600)
Figure's size in pixels, format as (x, y).

filename: str, Path or None, default=None
Save the plot using this name. Use "auto" for automatic naming. The type of the file depends on the provided name (.html, .png, .pdf, etc...). If filename has no file type, the plot is saved as html. If None, the plot is not saved.

display: bool or None, default=True
Whether to render the plot. If None, it returns the figure.

Returns{#plot_series-go.Figure or None} go.Figure or None
Plot object. Only returned if display=None.


See Also

plot_distribution

Plot column distributions.

plot_relationships

Plot pairwise relationships in a dataset.

plot_qq

Plot a quantile-quantile plot.


Example

>>> from atom import ATOMForecaster
>>> from sktime.datasets import load_airline

>>> y = load_airline()

>>> atom = ATOMForecaster(y, random_state=1)
>>> atom.plot_series()