teehr.metrics.deterministic_funcs

Contains UDFs for deterministic metric calculations in Spark queries.

Functions

annual_peak_relative_bias	Create the annual_peak_relative_bias metric function.
kling_gupta_efficiency	Create the kling_gupta_efficiency metric function.
kling_gupta_efficiency_mod1	Create the kling_gupta_efficiency_mod1 metric function.
kling_gupta_efficiency_mod2	Create the kling_gupta_efficiency_mod2 metric function.
max_value_delta	Create the max_value_delta metric function.
max_value_timedelta	Create the max_value_timedelta metric function.
mean_absolute_error	Create the mean_absolute_error metric function.
mean_absolute_relative_error	Create the Absolute Relative Error metric function.
mean_error	Create the Mean Error metric function.
mean_squared_error	Create the mean_squared_error metric function.
multiplicative_bias	Create the Multiplicative Bias metric function.
nash_sutcliffe_efficiency	Create the nash_sutcliffe_efficiency metric function.
nash_sutcliffe_efficiency_normalized	Create the nash_sutcliffe_efficiency_normalized metric function.
pearson_correlation	Create the Pearson Correlation Coefficient metric function.
r_squared	Create the R-squared metric function.
relative_bias	Create the Relative Bias metric function.
root_mean_squared_error	Create the root_mean_squared_error metric function.
root_mean_standard_deviation_ratio	Create the root_mean_standard_deviation_ratio metric function.
spearman_correlation	Create the Spearman metric function.

teehr.metrics.deterministic_funcs.annual_peak_relative_bias(model: MetricsBasemodel) → Callable

Create the annual_peak_relative_bias metric function.

teehr.metrics.deterministic_funcs.kling_gupta_efficiency(model: MetricsBasemodel) → Callable

Create the kling_gupta_efficiency metric function.

teehr.metrics.deterministic_funcs.kling_gupta_efficiency_mod1(model: MetricsBasemodel) → Callable

Create the kling_gupta_efficiency_mod1 metric function.

teehr.metrics.deterministic_funcs.kling_gupta_efficiency_mod2(model: MetricsBasemodel) → Callable

Create the kling_gupta_efficiency_mod2 metric function.

teehr.metrics.deterministic_funcs.max_value_delta(model: MetricsBasemodel) → Callable

Create the max_value_delta metric function.

teehr.metrics.deterministic_funcs.max_value_timedelta(model: MetricsBasemodel) → Callable

Create the max_value_timedelta metric function.

teehr.metrics.deterministic_funcs.mean_absolute_error(model: MetricsBasemodel) → Callable

Create the mean_absolute_error metric function.

teehr.metrics.deterministic_funcs.mean_absolute_relative_error(model: MetricsBasemodel) → Callable

Create the Absolute Relative Error metric function.

teehr.metrics.deterministic_funcs.mean_error(model: MetricsBasemodel) → Callable

Create the Mean Error metric function.

teehr.metrics.deterministic_funcs.mean_squared_error(model: MetricsBasemodel) → Callable

Create the mean_squared_error metric function.

teehr.metrics.deterministic_funcs.multiplicative_bias(model: MetricsBasemodel) → Callable

Create the Multiplicative Bias metric function.

teehr.metrics.deterministic_funcs.nash_sutcliffe_efficiency(model: MetricsBasemodel) → Callable

Create the nash_sutcliffe_efficiency metric function.

teehr.metrics.deterministic_funcs.nash_sutcliffe_efficiency_normalized(model: MetricsBasemodel) → Callable

Create the nash_sutcliffe_efficiency_normalized metric function.

teehr.metrics.deterministic_funcs.pearson_correlation(model: MetricsBasemodel) → Callable

Create the Pearson Correlation Coefficient metric function.

teehr.metrics.deterministic_funcs.r_squared(model: MetricsBasemodel) → Callable

Create the R-squared metric function.

teehr.metrics.deterministic_funcs.relative_bias(model: MetricsBasemodel) → Callable

Create the Relative Bias metric function.

teehr.metrics.deterministic_funcs.root_mean_squared_error(model: MetricsBasemodel) → Callable

Create the root_mean_squared_error metric function.

teehr.metrics.deterministic_funcs.root_mean_standard_deviation_ratio(model: MetricsBasemodel) → Callable

Create the root_mean_standard_deviation_ratio metric function.

teehr.metrics.deterministic_funcs.spearman_correlation(model: MetricsBasemodel) → Callable

Create the Spearman metric function.