teehr.metrics.deterministic_funcs#

Contains UDFs for deterministic metric calculations in Spark queries.

Functions

aprb_wrapper

Create the annual_peak_relative_bias metric function.

kge_mod1_wrapper

Create the kling_gupta_efficiency_mod1 metric function.

kge_mod2_wrapper

Create the kling_gupta_efficiency_mod2 metric function.

kge_wrapper

Create the kling_gupta_efficiency metric function.

mae_wrapper

Create the mean_absolute_error metric function.

mare_wrapper

Create the mean_absolute_relative_error metric function.

mb_wrapper

Create the multiplicative_bias metric function.

me_wrapper

Create the mean_error metric function.

mse_wrapper

Create the mean_squared_error metric function.

mvd_wrapper

Create the max_value_delta metric function.

mvtd_wrapper

Create the max_value_timedelta metric function.

nse_norm_wrapper

Create the nash_sutcliffe_efficiency_normalized metric function.

nse_wrapper

Create the nash_sutcliffe_efficiency metric function.

pc_wrapper

Create the pearson_correlation metric function.

r_squared_wrapper

Create the R-squared metric function.

rb_wrapper

Create the relative_bias metric function.

rmsdr_wrapper

Create the root_mean_standard_deviation_ratio metric function.

rmse_wrapper

Create the root_mean_squared_error metric function.

spearman_wrapper

Create the Spearman metric function.

teehr.metrics.deterministic_funcs.aprb_wrapper(model: MetricsBasemodel) Callable[source]#

Create the annual_peak_relative_bias metric function.

teehr.metrics.deterministic_funcs.kge_mod1_wrapper(model: MetricsBasemodel) Callable[source]#

Create the kling_gupta_efficiency_mod1 metric function.

teehr.metrics.deterministic_funcs.kge_mod2_wrapper(model: MetricsBasemodel) Callable[source]#

Create the kling_gupta_efficiency_mod2 metric function.

teehr.metrics.deterministic_funcs.kge_wrapper(model: MetricsBasemodel) Callable[source]#

Create the kling_gupta_efficiency metric function.

teehr.metrics.deterministic_funcs.mae_wrapper(model: MetricsBasemodel) Callable[source]#

Create the mean_absolute_error metric function.

teehr.metrics.deterministic_funcs.mare_wrapper(model: MetricsBasemodel) Callable[source]#

Create the mean_absolute_relative_error metric function.

teehr.metrics.deterministic_funcs.mb_wrapper(model: MetricsBasemodel) Callable[source]#

Create the multiplicative_bias metric function.

teehr.metrics.deterministic_funcs.me_wrapper(model: MetricsBasemodel) Callable[source]#

Create the mean_error metric function.

teehr.metrics.deterministic_funcs.mse_wrapper(model: MetricsBasemodel) Callable[source]#

Create the mean_squared_error metric function.

teehr.metrics.deterministic_funcs.mvd_wrapper(model: MetricsBasemodel) Callable[source]#

Create the max_value_delta metric function.

teehr.metrics.deterministic_funcs.mvtd_wrapper(model: MetricsBasemodel) Callable[source]#

Create the max_value_timedelta metric function.

teehr.metrics.deterministic_funcs.nse_norm_wrapper(model: MetricsBasemodel) Callable[source]#

Create the nash_sutcliffe_efficiency_normalized metric function.

teehr.metrics.deterministic_funcs.nse_wrapper(model: MetricsBasemodel) Callable[source]#

Create the nash_sutcliffe_efficiency metric function.

teehr.metrics.deterministic_funcs.pc_wrapper(model: MetricsBasemodel) Callable[source]#

Create the pearson_correlation metric function.

teehr.metrics.deterministic_funcs.r_squared_wrapper(model: MetricsBasemodel) Callable[source]#

Create the R-squared metric function.

teehr.metrics.deterministic_funcs.rb_wrapper(model: MetricsBasemodel) Callable[source]#

Create the relative_bias metric function.

teehr.metrics.deterministic_funcs.rmsdr_wrapper(model: MetricsBasemodel) Callable[source]#

Create the root_mean_standard_deviation_ratio metric function.

teehr.metrics.deterministic_funcs.rmse_wrapper(model: MetricsBasemodel) Callable[source]#

Create the root_mean_squared_error metric function.

teehr.metrics.deterministic_funcs.spearman_wrapper(model: MetricsBasemodel) Callable[source]#

Create the Spearman metric function.