hookeai.model_architectures.procedures.convergence_plots.plot_time_series_convergence_uq

plot_time_series_convergence_uq(models_base_dirs, training_dirs, testing_dirs, predictions_dirs, prediction_types, plot_type='time_series_scatter', samples_ids='all', filename='time_series_convergence', save_dir=None, is_save_fig=False, is_stdout_display=False, is_latex=True)[source]

Plot time series predictions versus ground-truth.

Uncertainty quantification data accounting for different model samples predictions for each training data set size is required. The corresponding directory named ‘uncertainty_quantification’ should exist in each model base directory.

Parameters:

  • models_base_dirs (tuple[str]) – Base directory where each model is stored.

  • training_dirs (tuple[str]) – Directory where each model training data set is stored.

  • testing_dirs (tuple[str]) – Directory where each model testing data set is stored.

  • predictions_dirs (tuple[str]) – Directory where each model samples predictions results files are stored.

  • plot_type ({'time_series_scatter', 'time_series_path'}, default='time_series_scatter') – Time series plot type.

  • samples_ids ({'all', list[int]}, default='all') – Samples IDs whose prediction data is plotted.

  • filename (str, default='prediction_path_convergence') – 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.