Regression Metrics
*******************



Functional API
===============
SeqMetrics also provides a functional API for all the performance
metrics.

.. autofunction:: SeqMetrics.acc
.. autofunction:: SeqMetrics.adjusted_r2
.. autofunction:: SeqMetrics.agreement_index
.. autofunction:: SeqMetrics.aitchison
.. autofunction:: SeqMetrics.aic
.. autofunction:: SeqMetrics.amemiya_pred_criterion
.. autofunction:: SeqMetrics.amemiya_adj_r2
.. autofunction:: SeqMetrics.bias
.. autofunction:: SeqMetrics.bic
.. autofunction:: SeqMetrics.brier_score
.. autofunction:: SeqMetrics.centered_rms_dev
.. autofunction:: SeqMetrics.coeff_of_persistence
.. autofunction:: SeqMetrics.corr_coeff
.. autofunction:: SeqMetrics.covariance
.. autofunction:: SeqMetrics.concordance_corr_coef
.. autofunction:: SeqMetrics.cosine_similarity
.. autofunction:: SeqMetrics.critical_success_index
.. autofunction:: SeqMetrics.cronbach_alpha
.. autofunction:: SeqMetrics.decomposed_mse
.. autofunction:: SeqMetrics.euclid_distance
.. autofunction:: SeqMetrics.exp_var_score
.. autofunction:: SeqMetrics.expanded_uncertainty
.. autofunction:: SeqMetrics.fdc_fhv
.. autofunction:: SeqMetrics.fdc_flv
.. autofunction:: SeqMetrics.gmae
.. autofunction:: SeqMetrics.gmean_diff
.. autofunction:: SeqMetrics.gmrae
.. autofunction:: SeqMetrics.inrse
.. autofunction:: SeqMetrics.irmse
.. autofunction:: SeqMetrics.JS
.. autofunction:: SeqMetrics.kendaull_tau
.. autofunction:: SeqMetrics.kge
.. autofunction:: SeqMetrics.kge_bound
.. autofunction:: SeqMetrics.kge_mod
.. autofunction:: SeqMetrics.kge_np
.. autofunction:: SeqMetrics.kgeprime_c2m
.. autofunction:: SeqMetrics.kgenp_bound
.. autofunction:: SeqMetrics.kl_sym
.. autofunction:: SeqMetrics.kl_divergence
.. autofunction:: SeqMetrics.lm_index
.. autofunction:: SeqMetrics.log_prob
.. autofunction:: SeqMetrics.log_nse
.. autofunction:: SeqMetrics.log_cosh_error
.. autofunction:: SeqMetrics.legates_coeff_eff
.. autofunction:: SeqMetrics.maape
.. autofunction:: SeqMetrics.mae
.. autofunction:: SeqMetrics.mape
.. autofunction:: SeqMetrics.mase
.. autofunction:: SeqMetrics.mare
.. autofunction:: SeqMetrics.max_error
.. autofunction:: SeqMetrics.mape_for_peaks
.. autofunction:: SeqMetrics.manhattan_distance
.. autofunction:: SeqMetrics.mapd
.. autofunction:: SeqMetrics.mbe
.. autofunction:: SeqMetrics.mbrae
.. autofunction:: SeqMetrics.mb_r
.. autofunction:: SeqMetrics.msle
.. autofunction:: SeqMetrics.med_seq_error
.. autofunction:: SeqMetrics.mda
.. autofunction:: SeqMetrics.mde
.. autofunction:: SeqMetrics.mdape
.. autofunction:: SeqMetrics.mdrae
.. autofunction:: SeqMetrics.me
.. autofunction:: SeqMetrics.mean_bias_error
.. autofunction:: SeqMetrics.mean_var
.. autofunction:: SeqMetrics.mean_poisson_deviance
.. autofunction:: SeqMetrics.mean_gamma_deviance
.. autofunction:: SeqMetrics.median_abs_error
.. autofunction:: SeqMetrics.mle
.. autofunction:: SeqMetrics.mod_agreement_index
.. autofunction:: SeqMetrics.mpe
.. autofunction:: SeqMetrics.mrae
.. autofunction:: SeqMetrics.mse
.. autofunction:: SeqMetrics.minkowski_distance
.. autofunction:: SeqMetrics.mre
.. autofunction:: SeqMetrics.nse
.. autofunction:: SeqMetrics.nse_alpha
.. autofunction:: SeqMetrics.nse_beta
.. autofunction:: SeqMetrics.nse_mod
.. autofunction:: SeqMetrics.nse_rel
.. autofunction:: SeqMetrics.nse_bound
.. autofunction:: SeqMetrics.nrmse
.. autofunction:: SeqMetrics.norm_euclid_distance
.. autofunction:: SeqMetrics.nrmse_range
.. autofunction:: SeqMetrics.nrmse_ipercentile
.. autofunction:: SeqMetrics.nrmse_mean
.. autofunction:: SeqMetrics.norm_ae
.. autofunction:: SeqMetrics.norm_nse
.. autofunction:: SeqMetrics.norm_ape
.. autofunction:: SeqMetrics.pbias
.. autofunction:: SeqMetrics.rae
.. autofunction:: SeqMetrics.ref_agreement_index
.. autofunction:: SeqMetrics.rel_agreement_index
.. autofunction:: SeqMetrics.relative_rmse
.. autofunction:: SeqMetrics.rmse
.. autofunction:: SeqMetrics.rmsle
.. autofunction:: SeqMetrics.rmdspe
.. autofunction:: SeqMetrics.r2
.. autofunction:: SeqMetrics.r2_score
.. autofunction:: SeqMetrics.rse
.. autofunction:: SeqMetrics.rrse
.. autofunction:: SeqMetrics.rmspe
.. autofunction:: SeqMetrics.rsr
.. autofunction:: SeqMetrics.rmsse
.. autofunction:: SeqMetrics.sga
.. autofunction:: SeqMetrics.sse
.. autofunction:: SeqMetrics.sa
.. autofunction:: SeqMetrics.sc
.. autofunction:: SeqMetrics.se
.. autofunction:: SeqMetrics.smape
.. autofunction:: SeqMetrics.smdape
.. autofunction:: SeqMetrics.sid
.. autofunction:: SeqMetrics.skill_score_murphy
.. autofunction:: SeqMetrics.std_ratio
.. autofunction:: SeqMetrics.spearmann_corr
.. autofunction:: SeqMetrics.tweedie_deviance_score
.. autofunction:: SeqMetrics.umbrae
.. autofunction:: SeqMetrics.variability_ratio
.. autofunction:: SeqMetrics.ve
.. autofunction:: SeqMetrics.volume_error
.. autofunction:: SeqMetrics.wape
.. autofunction:: SeqMetrics.watt_m
.. autofunction:: SeqMetrics.wmape


.. autofunction:: SeqMetrics.calculate_hydro_metrics



Class-Based API
==================
.. autoclass:: SeqMetrics.RegressionMetrics
   :members:
   :undoc-members:
   :show-inheritance:

   .. automethod:: __init__