Root Mean Square Error

class pbparam.RMSE[source]

The Root-Mean Square Error (RMSE) class, to evaluate error of simulation dataset to true dataset.

Parameters:

  • y_sim (array or list) – contains simulation data points

  • y_data (array or list) – contains reference data points

  • weights (dict, optional) – weights of the parameters

  • sd (float, optional) – standard deviation of error, not all cost function need it.

Returns:

RMSE – Calculated RMSE for given inputs.

Return type:

array

evaluate(y_sim, y_data, weights, sd=None)[source]

Evaluate RMSE cost function.

Parameters:

  • y_sim (array or list) – contains simulation data points

  • y_data (array or list) – contains reference data points

  • sd (array or list, optional) – contains the standard deviation of the data points, used for weighting the cost function. This variable will NOT be used in RMSE. Default is None.

  • weights (array or list, optional) – contains custom weights for each data point. Size of weights must be equal to size of reference data points!

Returns:

RMSE – Calculated RMSE for given inputs.

Return type:

array