API Reference¶
This page provides an auto-generated summary of xskillscore
’s API.
For more details and examples, refer to the relevant chapters in the main part of the
documentation.
Deterministic Metrics¶
Correlation Metrics¶
|
Pearson’s correlation coefficient. |
|
2-tailed p-value associated with pearson’s correlation coefficient. |
|
2-tailed p-value associated with Pearson’s correlation coefficient, accounting for autocorrelation. |
|
Spearman’s correlation coefficient. |
|
2-tailed p-value associated with Spearman’s correlation coefficient. |
|
2-tailed p-value associated with Spearman rank correlation coefficient, accounting for autocorrelation. |
|
Effective sample size for temporally correlated data. |
|
R^2 (coefficient of determination) score. |
Distance Metrics¶
|
Root Mean Squared Error. |
|
Mean Squared Error. |
|
Mean Absolute Error. |
|
Median Absolute Error. |
|
Symmetric Mean Absolute Percentage Error. |
|
Mean Absolute Percentage Error. |
Probabilistic Metrics¶
Currently, most of our probabilistic metrics are ported over from
properscoring to work with
xarray
DataArrays and Datasets.
|
Calculate Brier score (BS). |
|
Continuous Ranked Probability Score with the ensemble distribution |
|
Continuous Ranked Probability Score with a Gaussian distribution. |
|
Continuous Ranked Probability Score with numerical integration of the normal distribution. |
|
Calculate the Brier scores of an ensemble for exceeding given thresholds. |
|
Calculate Ranked Probability Score. |
|
Returns the rank histogram (Talagrand diagram) along the specified dimensions. |
|
Returns the data required to construct the discrimination diagram for an event; the histogram of forecasts likelihood when observations indicate an event has occurred and has not occurred. |
|
Returns the data required to construct the reliability diagram for an event; the relative frequencies of occurrence of an event for a range of forecast probability bins |
Contingency-based Metrics¶
These metrics rely upon the construction of a Contingency
object. The user calls the
individual methods to access metrics based on the table.
|
Class for contingency based skill scores |
Contingency table¶
Dichotomous-Only (yes/no) Metrics¶
|
Returns the number of hits (true positives) for dichotomous contingency data. |
|
Returns the number of misses (false negatives) for dichotomous contingency data. |
|
Returns the number of false alarms (false positives) for dichotomous contingency data. |
|
Returns the number of correct negatives (true negatives) for dichotomous contingency data. |
|
Returns the bias score(s) for dichotomous contingency data |
|
Returns the hit rate(s) (probability of detection) for dichotomous contingency data. |
|
Returns the false alarm ratio(s) for dichotomous contingency data. |
|
Returns the false alarm rate(s) (probability of false detection) for dichotomous contingency data. |
|
Returns the success ratio(s) for dichotomous contingency data. |
|
Returns the threat score(s) for dichotomous contingency data. |
|
Returns the equitable threat score(s) for dichotomous contingency data. |
|
Returns the odds ratio(s) for dichotomous contingency data |
Returns the odds ratio skill score(s) for dichotomous contingency data |
Multi-Category Metrics¶
Returns the accuracy score(s) for a contingency table with K categories |
|
Returns the Heidke skill score(s) for a contingency table with K categories |
|
Returns the Peirce skill score(s) (Hanssen and Kuipers discriminantor true skill statistic) for a contingency table with K categories. |
|
Returns Gerrity equitable score for a contingency table with K categories. |