Ctrl+K

candle.viz_utils.plot_decile_predictions

candle.viz_utils.plot_decile_predictions#

candle.viz_utils.plot_decile_predictions(Ypred, Ypred_Lp, Ypred_Hp, decile_list, pred_name=None, figprefix=None)#

Functionality to plot the mean of the deciles predicted. The plot generated is stored in a png file.

Parameters:

  • Ypred (numpy array) – Array with median predicted values.

  • Ypred_Lp (numpy array) – Array with low decile predicted values.

  • Ypred_Hp (numpy array) – Array with high decile predicted values.

  • decile_list (List) – List of deciles predicted (e.g. ‘1st’, ‘9th’, etc.)

  • pred_name (string) – Name of data colum or quantity predicted (e.g. growth, AUC, etc.)

  • figprefix (string) – String to prefix the filename to store the figure generated. A ‘_decile_predictions.png’ string will be appended to the figprefix given.

Contents