nwm_metrics.metric_functions.rmse_std_ratio

nwm_metrics.metric_functions.rmse_std_ratio(y_true, y_pred, root=False, warning_msg=False)

Compute ratio of RMSE between simulation and observation to standard deviation of observation.

Return type:

float

Parameters:

• y_true (pd.Series) – Ground truth or observations

• y_pred (pd.Series) – Modeled values or simulations

• root (bool, optional) – When True, compute RMSE for the numerator; when False, compute MSE for the numerator.

• warning_msg (bool, optional) – When True, display a warning message if the denominator is zero.

Returns:

Ratio of RMSE and standard deviation of observation

Return type:

float