hookeai.model_architectures.procedures.model_prediction.plot_time_series_prediction

plot_time_series_prediction(prediction_sets, is_reference_data=False, x_label='Time', y_label='Value', is_normalize_data=False, is_uncertainty_quantification=False, range_type='min-max', filename='time_series_prediction', save_dir=None, is_save_fig=False, is_stdout_display=False, is_latex=False)[source]

Plot time series predictions.

Parameters:

  • prediction_sets (dict) – One or more time series prediction processes, where each process (key, str) is stored as a data array (item, numpy.ndarray(2d)) of shape (sequence_length, 1 + n_predictions) as follows: data_array[:, 0] stores the time series time, data_array[:, 1:] stores the time series predictions.

  • is_reference_data (bool, default=False) – If True, then the first prediction process is assumed to be the reference and is formatted independently (black, dashed, on top).

  • x_label (str, default='Time') – x-axis label.

  • y_label (str, default='Value') – y-axis label.

  • is_normalize_data (bool, default=False) – Normalize time and predictions data to the range [0, 1].

  • is_uncertainty_quantification (bool, default=False) – If True, then plot the prediction processes range of time series predictions for each time. Assumes the same time series time for all the different prediction processes.

  • range_type ({'min-max', 'mean-std', None}, default='min-max') – Type of range used to plot the range of time series predictions for each time. If None, only the mean is plotted. Only effective if is_uncertainty_quantification is set to True.

  • filename (str, default='time_series_prediction') – Figure name.

  • save_dir (str, default=None) – Directory where figure is saved. If None, then figure is saved in current working directory.

  • is_save_fig (bool, default=False) – Save figure.

  • is_stdout_display (bool, default=False) – True if displaying figure to standard output device, False otherwise.

  • is_latex (bool, default=False) – If True, then render all strings in LaTeX. If LaTex is not available, then this option is silently set to False and all input strings are processed to remove $(…)$ enclosure.