src.plot.regression_plot

Classes

RegressionPlot(**kwargs)

class src.plot.regression_plot.RegressionPlot(**kwargs)

Author:

Alberto M. Esmoris Pena

Class to plot the evaluation of a regression task.

See MplPlot and RegressionEvaluation.

Variables:

• cases – See RegressionEvaluation.

• quantities – See RegressionEvaluation.

• errors – See RegressionEvaluation.

• distribution – See RegressionEvaluation.

• outers – See RegressionEvaluation.

• regression_eval_path – See RegressionEvaluation.

• regression_hist2d_path – See RegressionEvaluation.

• residual_path – See RegressionEvaluation.

• residual_hist2d_path – See RegressionEvaluation.

• scatter_path – See RegressionEvaluation.

• scatter_hist2d_path – See RegressionEvaluation.

• qq_path – See RegressionEvaluation.

• summary_path – See RegressionEvaluation.

__init__(**kwargs)

Initialize an instance of RegressionPlot.

Parameters:

kwargs – The key-word arguments defining the plot’s attributes.

plot(**kwargs)

Do the regression, residual, scatter, QQ, and summary plots for which the necessary information is available.

See plot.Plot.plot().

plot_regressions(path=None)

Plot the evaluation of the regressions.

plot_residuals(path=None)

Plot the residuals.

plot_regressions_hist2d(path=None)

Plot the evaluation of the regressions as a 2D histogram.

plot_residuals_hist2d(path=None)

Plot the residuals as a 2D histogram.

plot_scatter(path=None)

Plot the scatter.

plot_scatter_hist2d(path=None)

Plot the scatter as a 2D histogram.

plot_QQ(path=None)

Plot the QQ distribution (typically from the percentiles).

plot_summary(path=None)

Plot the summary.

static plot_error_scatter(ax, pred, pred_min, pred_max, error, ref_name, pred_name, error_name)

Plot the scatter plot between an error measurement and a feature/prediction.

static plot_error_hist2d(fig, ax, pred, error, ref_name, pred_name, error_name)

Plot the 2D histogram plot representing an error measurement and a feature/prediction.

has_residual_info()

Check whether the plot contains error data.

Returns:

True if the plot contains error data, False otherwise.

has_scatter_info()

Check whether the plot contains cases and quantities data.

Returns:

True if the plot contains cases and quantities data, False otherwise.

has_QQ_info()

Check whether the plot contains quantile distribution data.

Returns:

True if the plot contains quantile distribution data, False otherwise.

has_summary_info()

Check whether the plot contains error data.

Returns:

True if the plot contains error data, False otherwise.