"""Metrics for ``PredictionEnsemble.verify() and ``PredictionEnsemble.bootstrap()."""
import warnings
from typing import Any, Callable, Dict, List, Optional, Tuple, Union
import numpy as np
import xarray as xr
from scipy.stats import norm
from xskillscore import (
Contingency,
brier_score,
crps_ensemble,
crps_gaussian,
crps_quadrature,
discrimination,
effective_sample_size,
mae,
mape,
median_absolute_error,
mse,
pearson_r,
pearson_r_eff_p_value,
pearson_r_p_value,
rank_histogram,
reliability,
rmse,
roc,
rps,
smape,
spearman_r,
spearman_r_eff_p_value,
spearman_r_p_value,
threshold_brier_score,
)
from .constants import CLIMPRED_DIMS
dimType = Optional[Union[str, List[str]]]
metric_kwargsType = Any
[docs]def _get_norm_factor(comparison: Any) -> int: # Comparison instead of Any
"""Get normalization factor for normalizing distance metrics.
A distance metric is normalized by the standard deviation or variance
of the verification product. The goal of a normalized distance
metric is to get a constant and comparable value of typically 1 (or 0 for
metrics defined as 1 - metric), when the metric saturates and the predictability
horizon is reached.
To directly compare skill between different comparisons used, a factor is
added in the normalized metric formula, see Seferian et al. 2018.
For example, NRMSE gets smaller in comparison ``m2e`` than ``m2m`` by design,
because the ensemble mean is always closer to individual ensemble members
than ensemble members to each other.
.. note::
This is used for NMSE, NRMSE, MSSS, NMAE.
Args:
comparison: comparison class.
Returns:
fac: normalization factor.
Raises:
KeyError: if comparison is not matching.
Example:
>>> # check skill saturation value of roughly 1 for different comparisons
>>> for c in ["m2m", "m2e", "m2c", "e2c"]: # doctest: +ELLIPSIS
... s = PerfectModelEnsemble.verify(metric="nrmse", dim=None, comparison=c)
... s.tos.plot(label="nrmse {c}")
...
[...
References:
* :cite:t:`Griffies1997`
* :cite:t:`Collins2002`
* :cite:t:`Seferian2018`
"""
if comparison.name in ["m2e", "e2c", "e2o"]:
fac = 1
elif comparison.name in ["m2c", "m2m", "m2o"]:
fac = 2
else:
raise KeyError("specify comparison to get normalization factor.")
return fac
def _preprocess_dims(dim: dimType) -> List[str]:
"""Convert input argument ``dim`` into a list of dimensions.
Args:
dim: The dimension(s) to apply the function along.
Returns:
dim: List of dimensions to apply function over.
"""
if dim is None:
dim = ["time"]
elif isinstance(dim, str):
dim = [dim]
elif isinstance(dim, List):
pass
else:
raise ValueError
return dim
def _rename_dim(dim: dimType, forecast: xr.Dataset, verif: xr.Dataset) -> List[str]:
"""Rename ``dim`` to ``time`` or ``init`` if forecast and verif dims require."""
dim = _preprocess_dims(dim)
if "init" in dim and "time" in forecast.dims and "time" in verif.dims:
dim = dim.copy()
dim.remove("init")
dim = dim + ["time"]
elif "time" in dim and "init" in forecast.dims and "init" in verif.dims:
dim = dim.copy()
dim.remove("time")
dim = dim + ["init"]
return dim
def _remove_member_from_dim_or_raise(dim: dimType) -> List[str]:
"""
Delete ``member`` from ``dim``.
Not pass to ``xskillscore`` where expected as default ``member_dim``.
"""
dim = _preprocess_dims(dim)
if "member" in dim:
dim = dim.copy()
dim.remove("member")
else:
raise ValueError(f"Expected to find `member` in `dim`, found {dim}")
return dim
def _extract_and_apply_logical(
forecast: xr.Dataset,
verif: xr.Dataset,
metric_kwargs: Dict[Any, Any],
dim: dimType,
) -> Tuple[xr.Dataset, xr.Dataset, Dict[Any, Any], List[str]]:
"""Extract and apply callable.
Extract ``logical`` from ``metric_kwargs`` and apply to ``forecast`` and
``verif``.
"""
dim = _preprocess_dims(dim)
if "comparison" in metric_kwargs:
metric_kwargs = metric_kwargs.copy()
comparison = metric_kwargs.pop("comparison")
if "logical" in metric_kwargs:
logical = metric_kwargs.pop("logical")
if not callable(logical):
raise ValueError(f"`logical` must be `callable`, found {type(logical)}")
# apply logical: Function to get forecast probability
forecast = logical(forecast) # mean(member) later
forecast, dim = _maybe_member_mean_reduce_dim(forecast, dim)
verif = logical(verif).astype("int") # binary outcome
return forecast, verif, metric_kwargs, dim
elif (
comparison.name == "e2o"
and "logical" not in metric_kwargs
and "member" not in dim
): # allow e2o comparison without logical
return forecast, verif, metric_kwargs, dim
elif (
comparison.name == "m2o" and "logical" not in metric_kwargs and "member" in dim
): # allow m2o and member
return forecast, verif, metric_kwargs, dim
else:
raise ValueError(
"Please provide a callable `logical` to be applied to forecast and \
verification data to get forecast probabilities or binary forecast with \
member dimension and binary verification."
)
def _maybe_member_mean_reduce_dim(
forecast: xr.Dataset, dim: dimType
) -> Tuple[xr.Dataset, List[str]]:
"""
Take ``member`` mean if ``member`` in ``dim``.
To allow Option 2 in discrimination and reliability, which both dont expect
``member`` dim.
"""
dim = _preprocess_dims(dim)
if "member" in dim and "member" in forecast.dims:
forecast = forecast.mean("member")
dim = dim.copy()
dim.remove("member")
return forecast, dim
[docs]class Metric:
"""Master class for all metrics. See :ref:`metrics`."""
[docs] def __init__(
self,
name: str,
function: Callable,
positive: Optional[bool],
probabilistic: bool,
unit_power: float,
long_name: Optional[str] = None,
aliases: Optional[List[str]] = None,
minimum: Optional[float] = None,
maximum: Optional[float] = None,
perfect: Optional[float] = None,
normalize: bool = False,
allows_logical: bool = False,
requires_member_dim: bool = False,
):
"""Metric initialization. See :ref:`metrics`.
Args:
name: name of metric.
function: metric function.
positive: Is metric positively oriented?
If ``True``, higher skill value means better skill.
If ``False``, lower metric value means better skill.
``None`` if different differentiation.
probabilistic: Is metric probabilistic?
``False`` means deterministic.
unit_power: Power of the unit of skill based on unit
of input, e.g. input unit [m]: skill unit [(m)**unit_power]
long_name: long name of metric. Defaults to ``None``.
aliases: Allowed aliases for this metric.
Defaults to ``None``.
min: Minimum skill for metric. Defaults to ``None``.
max: Maxmimum skill for metric. Defaults to ``None``.
perfect: Perfect skill for metric. Defaults to ``None``.
normalize: Will the metric be normalized? Then metric
function will require to get Comparison passed. Defaults to ``False``.
allows_logical: Does the metric allow a logical to be
passed in metric_kwargs? Some probabilistic metrics allow this.
Defaults to ``False``.
requires_member_dim: Does xskillscore.metric expect a member dimension?
Defaults to ``False``.
"""
self.name = name
self.function = function
self.positive = positive
self.probabilistic = probabilistic
self.unit_power = unit_power
self.long_name = long_name
self.aliases = aliases
self.minimum = minimum
self.maximum = maximum
self.perfect = perfect
self.normalize = normalize
self.allows_logical = allows_logical
self.requires_member_dim = requires_member_dim
[docs] def __repr__(self) -> str:
"""Show metadata of metric class."""
summary = "----- Metric metadata -----\n"
summary += f"Name: {self.name}\n"
summary += f"Alias: {self.aliases}\n"
# positively oriented
if self.positive:
summary += "Orientation: positive\n"
else:
summary += "Orientation: negative\n"
# probabilistic or deterministic
if self.probabilistic:
summary += "Kind: probabilistic\n"
else:
summary += "Kind: deterministic\n"
summary += f"Power to units: {self.unit_power}\n"
summary += f"long_name: {self.long_name}\n"
summary += f"Minimum skill: {self.minimum}\n"
summary += f"Maximum skill: {self.maximum}\n"
summary += f"Perfect skill: {self.perfect}\n"
summary += f"Normalize: {self.normalize}\n"
summary += f"Allows logical: {self.allows_logical}\n"
# doc
summary += f"Function: {self.function.__doc__}\n"
return summary
#####################
# CORRELATION METRICS
#####################
[docs]def _pearson_r(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Pearson product-moment correlation coefficient.
A measure of the linear association between the forecast and verification data that
is independent of the mean and variance of the individual distributions. This is
also known as the Anomaly Correlation Coefficient (ACC) when correlating anomalies.
.. math::
corr = \frac{cov(f, o)}{\sigma_{f}\cdot\sigma_{o}},
where :math:`\sigma_{f}` and :math:`\sigma_{o}` represent the standard deviation
of the forecast and verification data over the experimental period, respectively.
.. note::
Use metric :py:func:`~climpred.metrics._pearson_r_p_value` or
:py:func:`~climpred.metrics._pearson_r_eff_p_value` to get the
corresponding p value.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.pearson_r`
Notes:
+-----------------+-----------+
| **minimum** | -1.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | positive |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.pearson_r`
* :py:func:`.xskillscore.pearson_r_p_value`
* :py:func:`~climpred.metrics._pearson_r_p_value`
* :py:func:`~climpred.metrics._pearson_r_eff_p_value`
Example:
>>> HindcastEnsemble.verify(
... metric="pearson_r",
... comparison="e2o",
... alignment="same_verifs",
... dim=["init"],
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.9272 0.9145 0.9127 0.9319 ... 0.9315 0.9185 0.9112
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: pearson_r
comparison: e2o
dim: ['init']
reference: []
"""
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=RuntimeWarning)
return pearson_r(forecast, verif, dim=dim, **metric_kwargs)
__pearson_r = Metric(
name="pearson_r",
function=_pearson_r,
positive=True,
probabilistic=False,
unit_power=0.0,
long_name="Pearson product-moment correlation coefficient",
aliases=["pr", "acc", "pacc"],
minimum=-1.0,
maximum=1.0,
perfect=1.0,
)
[docs]def _pearson_r_p_value(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
"""Probability that forecast and verification data are linearly uncorrelated.
Two-tailed p value associated with the Pearson product-moment correlation
coefficient :py:func:`~climpred.metrics._pearson_r`, assuming that all samples are
independent. Use :py:func:`~climpred.metrics._pearson_r_eff_p_value` to account for
autocorrelation in the forecast and verification data.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.pearson_r_p_value`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.pearson_r`
* :py:func:`.xskillscore.pearson_r_p_value`
* :py:func:`~climpred.metrics._pearson_r`
* :py:func:`~climpred.metrics._pearson_r_eff_p_value`
Example:
>>> HindcastEnsemble.verify(
... metric="pearson_r_p_value",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 5.779e-23 2.753e-21 4.477e-21 ... 8.7e-22 6.781e-21
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: pearson_r_p_value
comparison: e2o
dim: init
reference: []
"""
# p value returns a runtime error when working with NaNs, such as on a climate
# model grid. We can avoid this annoying output by specifically suppressing
# warning here.
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=Warning)
return pearson_r_p_value(forecast, verif, dim=dim, **metric_kwargs)
__pearson_r_p_value = Metric(
name="pearson_r_p_value",
function=_pearson_r_p_value,
positive=False,
probabilistic=False,
unit_power=0.0,
long_name="Pearson product-moment correlation coefficient p value",
aliases=["p_pval", "pvalue", "pval"],
minimum=0.0,
maximum=1.0,
perfect=0.0,
)
[docs]def _effective_sample_size(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Effective sample size for temporally correlated data.
.. note::
Weights are not included here due to the dependence on temporal autocorrelation.
.. note::
This metric can only be used for hindcast-type simulations.
The effective sample size extracts the number of independent samples
between two time series being correlated. This is derived by assessing
the magnitude of the lag-1 autocorrelation coefficient in each of the time series
being correlated. A higher autocorrelation induces a lower effective sample
size which raises the correlation coefficient for a given p value.
The effective sample size is used in computing the effective p value. See
:py:func:`~climpred.metrics._pearson_r_eff_p_value` and
:py:func:`~climpred.metrics._spearman_r_eff_p_value`.
.. math::
N_{eff} = N\left( \frac{1 -
\rho_{f}\rho_{o}}{1 + \rho_{f}\rho_{o}} \right),
where :math:`\rho_{f}` and :math:`\rho_{o}` are the lag-1 autocorrelation
coefficients for the forecast and verification data.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.effective_sample_size`
Notes:
+-----------------+-----------------+
| **minimum** | 0.0 |
+-----------------+-----------------+
| **maximum** | ∞ |
+-----------------+-----------------+
| **perfect** | N/A |
+-----------------+-----------------+
| **orientation** | positive |
+-----------------+-----------------+
References:
:cite:t:`Bretherton1999`
Example:
>>> HindcastEnsemble.verify(
... metric="effective_sample_size",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 5.0 4.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: effective_sample_size
comparison: e2o
dim: init
reference: []
"""
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=RuntimeWarning)
return effective_sample_size(forecast, verif, dim=dim, **metric_kwargs)
__effective_sample_size = Metric(
name="effective_sample_size",
function=_effective_sample_size,
positive=True,
probabilistic=False,
unit_power=0.0,
long_name="Effective sample size for temporally correlated data",
aliases=["n_eff", "eff_n"],
minimum=0.0,
maximum=np.inf,
)
[docs]def _pearson_r_eff_p_value(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""pearson_r_p_value accounting for autocorrelation.
.. note::
Weights are not included here due to the dependence on temporal autocorrelation.
.. note::
This metric can only be used for hindcast-type simulations.
The effective p value is computed by replacing the sample size :math:`N` in the
t-statistic with the effective sample size, :math:`N_{eff}`. The same Pearson
product-moment correlation coefficient :math:`r` is used as when computing the
standard p value.
.. math::
t = r\sqrt{ \frac{N_{eff} - 2}{1 - r^{2}} },
where :math:`N_{eff}` is computed via the autocorrelation in the forecast and
verification data.
.. math::
N_{eff} = N\left( \frac{1 -
\rho_{f}\rho_{o}}{1 + \rho_{f}\rho_{o}} \right),
where :math:`\rho_{f}` and :math:`\rho_{o}` are the lag-1 autocorrelation
coefficients for the forecast and verification data.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.pearson_r_eff_p_value`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See Also:
* :py:func:`~climpred.metrics._effective_sample_size`
* :py:func:`~climpred.metrics._spearman_r_eff_p_value`
Example:
>>> HindcastEnsemble.verify(
... metric="pearson_r_eff_p_value",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.02333 0.08552 0.2679 ... 0.2369 0.2588 0.2703
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: pearson_r_eff_p_value
comparison: e2o
dim: init
reference: []
References:
:cite:t:`Bretherton1999`
"""
# p value returns a runtime error when working with NaNs, such as on a climate
# model grid. We can avoid this annoying output by specifically suppressing
# warning here.
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=Warning)
return pearson_r_eff_p_value(forecast, verif, dim=dim, **metric_kwargs)
__pearson_r_eff_p_value = Metric(
name="pearson_r_eff_p_value",
function=_pearson_r_eff_p_value,
positive=False,
probabilistic=False,
unit_power=0.0,
long_name=(
"Pearson's Anomaly correlation coefficient "
"p value using the effective sample size"
),
aliases=["p_pval_eff", "pvalue_eff", "pval_eff"],
minimum=0.0,
maximum=1.0,
perfect=0.0,
)
[docs]def _spearman_r(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Spearman's rank correlation coefficient.
.. math::
corr = \mathrm{pearsonr}(ranked(f), ranked(o))
This correlation coefficient is nonparametric and assesses how well the relationship
between the forecast and verification data can be described using a monotonic
function. It is computed by first ranking the forecasts and verification data, and
then correlating those ranks using the :py:func:`~climpred.metrics._pearson_r`
correlation.
This is also known as the anomaly correlation coefficient (ACC) when comparing
anomalies, although the Pearson product-moment correlation coefficient
:py:func:`~climpred.metrics._pearson_r` is typically used when computing the ACC.
.. note::
Use metric :py:func:`~climpred.metrics._spearman_r_p_value` or
:py:func:`~climpred.metrics._spearman_r_eff_p_value`` to get the
corresponding p value.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.spearman_r`
Notes:
+-----------------+-----------+
| **minimum** | -1.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | positive |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.spearman_r`
* :py:func:`.xskillscore.spearman_r_p_value`
* :py:func:`~climpred.metrics._spearman_r_p_value`
* :py:func:`~climpred.metrics._spearman_r_eff_p_value`
Example:
>>> HindcastEnsemble.verify(
... metric="spearman_r",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.9336 0.9311 0.9293 0.9474 ... 0.9465 0.9346 0.9328
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: spearman_r
comparison: e2o
dim: init
reference: []
"""
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=RuntimeWarning)
return spearman_r(forecast, verif, dim=dim, **metric_kwargs)
__spearman_r = Metric(
name="spearman_r",
function=_spearman_r,
positive=True,
probabilistic=False,
unit_power=0.0,
long_name="Spearman's rank correlation coefficient",
aliases=["sacc", "sr"],
minimum=-1.0,
maximum=1.0,
perfect=1.0,
)
[docs]def _spearman_r_p_value(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Probability that forecast and verification data are monotonically uncorrelated.
Two-tailed p value associated with the Spearman's rank correlation
coefficient :py:func:`~climpred.metrics._spearman_r`, assuming that all samples are
independent. Use :py:func:`~climpred.metrics._spearman_r_eff_p_value` to account
for autocorrelation in the forecast and verification data.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.spearman_r_p_value`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.spearman_r`
* :py:func:`.xskillscore.spearman_r_p_value`
* :py:func:`~climpred.metrics._spearman_r`
* :py:func:`~climpred.metrics._spearman_r_eff_p_value`
Example:
>>> HindcastEnsemble.verify(
... metric="spearman_r_p_value",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 6.248e-24 1.515e-23 ... 4.288e-24 8.254e-24
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: spearman_r_p_value
comparison: e2o
dim: init
reference: []
"""
# p value returns a runtime error when working with NaNs, such as on a climate
# model grid. We can avoid this annoying output by specifically suppressing
# warning here.
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=RuntimeWarning)
return spearman_r_p_value(forecast, verif, dim=dim, **metric_kwargs)
__spearman_r_p_value = Metric(
name="spearman_r_p_value",
function=_spearman_r_p_value,
positive=False,
probabilistic=False,
unit_power=0.0,
long_name="Spearman's rank correlation coefficient p value",
aliases=["s_pval", "spvalue", "spval"],
minimum=0.0,
maximum=1.0,
perfect=0.0,
)
[docs]def _spearman_r_eff_p_value(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""_spearman_r_p_value accounting for autocorrelation.
.. note::
Weights are not included here due to the dependence on temporal autocorrelation.
.. note::
This metric can only be used for hindcast-type simulations.
The effective p value is computed by replacing the sample size :math:`N` in the
t-statistic with the effective sample size, :math:`N_{eff}`. The same Spearman's
rank correlation coefficient :math:`r` is used as when computing the standard p
value.
.. math::
t = r\sqrt{ \frac{N_{eff} - 2}{1 - r^{2}} },
where :math:`N_{eff}` is computed via the autocorrelation in the forecast and
verification data.
.. math::
N_{eff} = N\left( \frac{1 -
\rho_{f}\rho_{o}}{1 + \rho_{f}\rho_{o}} \right),
where :math:`\rho_{f}` and :math:`\rho_{o}` are the lag-1 autocorrelation
coefficients for the forecast and verification data.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.spearman_r_eff_p_value`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See Also:
* :py:func:`~climpred.metrics._effective_sample_size`
* :py:func:`~climpred.metrics._pearson_r_eff_p_value`
References:
:cite:t:`Bretherton1999`
Example:
>>> HindcastEnsemble.verify(
... metric="spearman_r_eff_p_value",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.02034 0.0689 0.2408 ... 0.2092 0.2315 0.2347
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: spearman_r_eff_p_value
comparison: e2o
dim: init
reference: []
"""
# p value returns a runtime error when working with NaNs, such as on a climate
# model grid. We can avoid this annoying output by specifically suppressing
# warning here.
with warnings.catch_warnings():
warnings.simplefilter("ignore", category=Warning)
return spearman_r_eff_p_value(forecast, verif, dim=dim, **metric_kwargs)
__spearman_r_eff_p_value = Metric(
name="spearman_r_eff_p_value",
function=_spearman_r_eff_p_value,
positive=False,
probabilistic=False,
unit_power=0.0,
long_name=(
"Spearman's Rank correlation coefficient "
"p value using the effective sample size"
),
aliases=["s_pval_eff", "spvalue_eff", "spval_eff"],
minimum=0.0,
maximum=1.0,
perfect=0.0,
)
##################
# DISTANCE METRICS
##################
[docs]def _mse(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Mean Sqaure Error (MSE).
.. math::
MSE = \overline{(f - o)^{2}}
The average of the squared difference between forecasts and verification data. This
incorporates both the variance and bias of the estimator. Because the error is
squared, it is more sensitive to large forecast errors than ``mae``, and thus a
more conservative metric. For example, a single error of 2°C counts the same as
two 1°C errors when using ``mae``. On the other hand, the 2°C error counts double
for ``mse``. See Jolliffe and Stephenson, 2011.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.mse`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.mse`
References:
:cite:t:`Jolliffe2011`
Example:
>>> HindcastEnsemble.verify(
... metric="mse", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.006202 0.006536 0.007771 ... 0.02417 0.02769
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: mse
comparison: e2o
dim: init
reference: []
"""
return mse(forecast, verif, dim=dim, **metric_kwargs)
__mse = Metric(
name="mse",
function=_mse,
positive=False,
probabilistic=False,
unit_power=2,
long_name="Mean Squared Error",
minimum=0.0,
maximum=np.inf,
perfect=0.0,
)
[docs]def _spread(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Ensemble spread taking the standard deviation over the member dimension.
.. math::
spread = std(f) = \sigma^2(f) = \sqrt\frac{\sum{(f-\overline{f})^2}}{N}
Args:
forecast: Forecast.
verif: Verification data (not used).
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`~xarray.std`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | obs.std() |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
Example:
>>> HindcastEnsemble.verify(
... metric="spread",
... comparison="m2o",
... alignment="same_verifs",
... dim=["member", "init"],
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.1468 0.1738 0.1922 0.2096 ... 0.2142 0.2178 0.2098
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: spread
comparison: m2o
dim: ['member', 'init']
reference: []
"""
return forecast.std(dim=dim, **metric_kwargs)
__spread = Metric(
name="spread",
function=_spread,
positive=False,
probabilistic=False,
unit_power=1,
long_name="Ensemble spread",
minimum=0.0,
maximum=np.inf,
perfect=False,
)
[docs]def _rmse(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Root Mean Sqaure Error (RMSE).
.. math::
RMSE = \sqrt{\overline{(f - o)^{2}}}
The square root of the average of the squared differences between forecasts and
verification data.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.rmse`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.rmse`
Example:
>>> HindcastEnsemble.verify(
... metric="rmse", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.07875 0.08085 0.08815 ... 0.1371 0.1555 0.1664
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: rmse
comparison: e2o
dim: init
reference: []
"""
return rmse(forecast, verif, dim=dim, **metric_kwargs)
__rmse = Metric(
name="rmse",
function=_rmse,
positive=False,
probabilistic=False,
unit_power=1,
long_name="Root Mean Squared Error",
minimum=0.0,
maximum=np.inf,
perfect=0.0,
)
[docs]def _mae(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Mean Absolute Error (MAE).
.. math::
MAE = \overline{|f - o|}
The average of the absolute differences between forecasts and verification data.
A more robust measure of forecast accuracy than ``mse`` which is sensitive to large
outlier forecast errors.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.mae`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.mae`
References:
:cite:t:`Jolliffe2011`
Example:
>>> HindcastEnsemble.verify(
... metric="mae", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.06484 0.06684 0.07407 ... 0.1193 0.1361 0.1462
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: mae
comparison: e2o
dim: init
reference: []
"""
return mae(forecast, verif, dim=dim, **metric_kwargs)
__mae = Metric(
name="mae",
function=_mae,
positive=False,
probabilistic=False,
unit_power=1,
long_name="Mean Absolute Error",
minimum=0.0,
maximum=np.inf,
perfect=0.0,
)
__median_absolute_error = Metric(
name="median_absolute_error",
function=_median_absolute_error,
positive=False,
probabilistic=False,
unit_power=1,
long_name="Median Absolute Error",
minimum=0.0,
maximum=np.inf,
perfect=0.0,
)
#############################
# NORMALIZED DISTANCE METRICS
#############################
[docs]def _nmse(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Compte Normalized MSE (NMSE), also known as Normalized Ensemble Variance (NEV).
Mean Square Error (``mse``) normalized by the variance of the verification data.
.. math::
NMSE = NEV = \frac{MSE}{\sigma^2_{o}\cdot fac}
= \frac{\overline{(f - o)^{2}}}{\sigma^2_{o} \cdot fac},
where :math:`fac` is 1 when using comparisons involving the ensemble mean (``m2e``,
``e2c``, ``e2o``) and 2 when using comparisons involving individual ensemble
members (``m2c``, ``m2m``, ``m2o``). See
:py:func:`~climpred.metrics._get_norm_factor`.
.. note::
``climpred`` uses a single-valued internal reference forecast for the
NMSE, in the terminology of :cite:t:`Murphy1988`. I.e., we use a single
climatological variance of the verification data *within* the experimental
window for normalizing MSE.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
comparison: Name comparison needed for normalization factor `fac`, see
:py:func:`~climpred.metrics._get_norm_factor`
(Handled internally by the compute functions)
metric_kwargs: see :py:func:`.xskillscore.mse`
Notes:
+----------------------------+-----------+
| **minimum** | 0.0 |
+----------------------------+-----------+
| **maximum** | ∞ |
+----------------------------+-----------+
| **perfect** | 0.0 |
+----------------------------+-----------+
| **orientation** | negative |
+----------------------------+-----------+
| **better than climatology**| 0.0 - 1.0 |
+----------------------------+-----------+
| **worse than climatology** | > 1.0 |
+----------------------------+-----------+
References:
:cite:t:`Griffies1997`
Example:
>>> HindcastEnsemble.verify(
... metric="nmse", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.1732 0.1825 0.217 0.2309 ... 0.5247 0.6749 0.7732
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: nmse
comparison: e2o
dim: init
reference: []
"""
if "comparison" in metric_kwargs:
comparison = metric_kwargs.pop("comparison")
else:
raise ValueError(
"Comparison needed to normalize NMSE. Not found in", metric_kwargs
)
mse_skill = _mse(forecast, verif, dim=dim, **metric_kwargs)
var = verif.var(dim)
fac = _get_norm_factor(comparison)
nmse_skill = mse_skill / var / fac
return nmse_skill
__nmse = Metric(
name="nmse",
function=_nmse,
positive=False,
probabilistic=False,
unit_power=0.0,
long_name="Normalized Mean Squared Error",
aliases=["nev"],
minimum=0.0,
maximum=np.inf,
perfect=0.0,
normalize=True,
)
[docs]def _nmae(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Compute Normalized Mean Absolute Error (NMAE).
Mean Absolute Error (``mae``) normalized by the standard deviation of the
verification data.
.. math::
NMAE = \frac{MAE}{\sigma_{o} \cdot fac}
= \frac{\overline{|f - o|}}{\sigma_{o} \cdot fac},
where :math:`fac` is 1 when using comparisons involving the ensemble mean (``m2e``,
``e2c``, ``e2o``) and 2 when using comparisons involving individual ensemble
members (``m2c``, ``m2m``, ``m2o``). See
:py:func:`~climpred.metrics._get_norm_factor`.
.. note::
``climpred`` uses a single-valued internal reference forecast for the
NMAE, in the terminology of :cite:t:`Murphy1988`. I.e., we use a single
climatological standard deviation of the verification data *within* the
experimental window for normalizing MAE.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
comparison: Name comparison needed for normalization factor `fac`, see
:py:func:`~climpred.metrics._get_norm_factor`
(Handled internally by the compute functions)
metric_kwargs: see :py:func:`.xskillscore.mae`
Notes:
+----------------------------+-----------+
| **minimum** | 0.0 |
+----------------------------+-----------+
| **maximum** | ∞ |
+----------------------------+-----------+
| **perfect** | 0.0 |
+----------------------------+-----------+
| **orientation** | negative |
+----------------------------+-----------+
| **better than climatology**| 0.0 - 1.0 |
+----------------------------+-----------+
| **worse than climatology** | > 1.0 |
+----------------------------+-----------+
References:
* :cite:t:`Murphy1988`
* :cite:t:`Griffies1997`
Example:
>>> HindcastEnsemble.verify(
... metric="nmae", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.3426 0.3532 0.3914 0.3898 ... 0.6303 0.7194 0.7726
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: nmae
comparison: e2o
dim: init
reference: []
"""
if "comparison" in metric_kwargs:
comparison = metric_kwargs.pop("comparison")
else:
raise ValueError(
"Comparison needed to normalize NMAE. Not found in", metric_kwargs
)
mae_skill = _mae(forecast, verif, dim=dim, **metric_kwargs)
std = verif.std(dim)
fac = _get_norm_factor(comparison)
nmae_skill = mae_skill / std / fac
return nmae_skill
__nmae = Metric(
name="nmae",
function=_nmae,
positive=False,
probabilistic=False,
unit_power=0,
long_name="Normalized Mean Absolute Error",
minimum=0.0,
maximum=np.inf,
perfect=0.0,
normalize=True,
)
[docs]def _nrmse(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Compute Normalized Root Mean Square Error (NRMSE).
Root Mean Square Error (``rmse``) normalized by the standard deviation of the
verification data.
.. math::
NRMSE = \frac{RMSE}{\sigma_{o}\cdot\sqrt{fac}}
= \sqrt{\frac{MSE}{\sigma^{2}_{o}\cdot fac}}
= \sqrt{ \frac{\overline{(f - o)^{2}}}{ \sigma^2_{o}\cdot fac}},
where :math:`fac` is 1 when using comparisons involving the ensemble mean (``m2e``,
``e2c``, ``e2o``) and 2 when using comparisons involving individual ensemble
members (``m2c``, ``m2m``, ``m2o``). See
:py:func:`~climpred.metrics._get_norm_factor`.
.. note::
``climpred`` uses a single-valued internal reference forecast for the
NRMSE, in the terminology of :cite:t:`Murphy1988`. I.e., we use a single
climatological variance of the verification data *within* the experimental
window for normalizing RMSE.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
comparison: Name comparison needed for normalization factor `fac`, see
:py:func:`~climpred.metrics._get_norm_factor`
(Handled internally by the compute functions)
metric_kwargs: see :py:func:`.xskillscore.rmse`
Notes:
+----------------------------+-----------+
| **minimum** | 0.0 |
+----------------------------+-----------+
| **maximum** | ∞ |
+----------------------------+-----------+
| **perfect** | 0.0 |
+----------------------------+-----------+
| **orientation** | negative |
+----------------------------+-----------+
| **better than climatology**| 0.0 - 1.0 |
+----------------------------+-----------+
| **worse than climatology** | > 1.0 |
+----------------------------+-----------+
References:
* :cite:t:`Murphy1988`
* :cite:t:`Hawkins2014`
* :cite:t:`Bushuk2018`
Example:
>>> HindcastEnsemble.verify(
... metric="nrmse", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.4161 0.4272 0.4658 0.4806 ... 0.7244 0.8215 0.8793
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: nrmse
comparison: e2o
dim: init
reference: []
"""
if "comparison" in metric_kwargs:
comparison = metric_kwargs.pop("comparison")
else:
raise ValueError(
"Comparison needed to normalize NRMSE. Not found in", metric_kwargs
)
rmse_skill = _rmse(forecast, verif, dim=dim, **metric_kwargs)
std = verif.std(dim)
fac = _get_norm_factor(comparison)
nrmse_skill = rmse_skill / std / np.sqrt(fac)
return nrmse_skill
__nrmse = Metric(
name="nrmse",
function=_nrmse,
positive=False,
probabilistic=False,
unit_power=0,
long_name="Normalized Root Mean Squared Error",
minimum=0.0,
maximum=np.inf,
perfect=0.0,
normalize=True,
)
[docs]def _msess(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Mean Squared Error Skill Score (MSESS).
.. math::
MSESS = 1 - \frac{MSE}{\sigma^2_{ref} \cdot fac} =
1 - \frac{\overline{(f - o)^{2}}}{\sigma^2_{ref} \cdot fac},
where :math:`fac` is 1 when using comparisons involving the ensemble mean (``m2e``,
``e2c``, ``e2o``) and 2 when using comparisons involving individual ensemble
members (``m2c``, ``m2m``, ``m2o``). See
:py:func:`~climpred.metrics._get_norm_factor`.
This skill score can be intepreted as a percentage improvement in accuracy. I.e.,
it can be multiplied by 100%.
.. note::
``climpred`` uses a single-valued internal reference forecast for the
MSSS, in the terminology of :cite:t:`Murphy1988`. I.e., we use a single
climatological variance of the verification data *within* the experimental
window for normalizing MSE.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
comparison: Name comparison needed for normalization factor `fac`, see
:py:func:`~climpred.metrics._get_norm_factor`
(Handled internally by the compute functions)
metric_kwargs: see :py:func:`.xskillscore.mse`
Notes:
+----------------------------+-----------+
| **minimum** | -∞ |
+----------------------------+-----------+
| **maximum** | 1.0 |
+----------------------------+-----------+
| **perfect** | 1.0 |
+----------------------------+-----------+
| **orientation** | positive |
+----------------------------+-----------+
| **better than climatology**| > 0.0 |
+----------------------------+-----------+
| **equal to climatology** | 0.0 |
+----------------------------+-----------+
| **worse than climatology** | < 0.0 |
+----------------------------+-----------+
References:
* :cite:t:`Griffies1997`
* :cite:t:`Murphy1988`
* :cite:t:`Pohlmann2004`
* :cite:t:`Bushuk2018`
Example:
>>> HindcastEnsemble.verify(
... metric="msess", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.8268 0.8175 0.783 0.7691 ... 0.4753 0.3251 0.2268
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: msess
comparison: e2o
dim: init
reference: []
"""
if "comparison" in metric_kwargs:
comparison = metric_kwargs.pop("comparison")
else:
raise ValueError(
"Comparison needed to normalize MSSS. Not found in", metric_kwargs
)
mse_skill = _mse(forecast, verif, dim=dim, **metric_kwargs)
var = verif.var(dim)
fac = _get_norm_factor(comparison)
msess_skill = 1 - mse_skill / var / fac
return msess_skill
__msess = Metric(
name="msess",
function=_msess,
positive=True,
probabilistic=False,
unit_power=0,
long_name="Mean Squared Error Skill Score",
aliases=["ppp", "msss"],
minimum=-np.inf,
maximum=1.0,
perfect=1.0,
normalize=True,
)
[docs]def _mape(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Mean Absolute Percentage Error (MAPE).
Mean absolute error (``mae``) expressed as the fractional error relative to the
verification data.
.. math::
MAPE = \frac{1}{n} \sum \frac{|f-o|}{|o|}
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.mape`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.mape`
Example:
>>> HindcastEnsemble.verify(
... metric="mape", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 1.536 1.21 1.421 1.149 ... 1.078 1.369 1.833 1.245
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: mape
comparison: e2o
dim: init
reference: []
"""
return mape(forecast, verif, dim=dim, **metric_kwargs)
__mape = Metric(
name="mape",
function=_mape,
positive=False,
probabilistic=False,
unit_power=0,
long_name="Mean Absolute Percentage Error",
minimum=0.0,
maximum=1.0,
perfect=0.0,
)
[docs]def _smape(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Symmetric Mean Absolute Percentage Error (sMAPE).
Similar to the Mean Absolute Percentage Error (``mape``), but sums the forecast and
observation mean in the denominator.
.. math::
sMAPE = \frac{1}{n} \sum \frac{|f-o|}{|f|+|o|}
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.smape`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.smape`
Example:
>>> HindcastEnsemble.verify(
... metric="smape", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.3801 0.3906 0.4044 0.3819 ... 0.4822 0.5054 0.5295
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: smape
comparison: e2o
dim: init
reference: []
"""
return smape(forecast, verif, dim=dim, **metric_kwargs)
__smape = Metric(
name="smape",
function=_smape,
positive=False,
probabilistic=False,
unit_power=0,
long_name="symmetric Mean Absolute Percentage Error",
minimum=0.0,
maximum=1.0,
perfect=0.0,
)
[docs]def _uacc(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Bushuk's unbiased Anomaly Correlation Coefficient (uACC).
This is typically used in perfect model studies. Because the perfect model Anomaly
Correlation Coefficient (ACC) is strongly state dependent, a standard ACC (e.g. one
computed using :py:func:`~climpred.metrics._pearson_r`) will be highly sensitive to
the set of start dates chosen for the perfect model study.
The Mean Square Skill Score (``MESSS``) can be
related directly to the ACC as ``MESSS = ACC^(2)`` (see :cite:t:`Murphy1988` and
:cite:t:`Bushuk2018`), so the unbiased ACC can be derived as ``uACC = sqrt(MESSS)``.
.. math::
uACC = \sqrt{MSESS}
= \sqrt{1 - \frac{\overline{(f - o)^{2}}}{\sigma^2_{ref} \cdot fac}},
where :math:`fac` is 1 when using comparisons involving the ensemble mean (``m2e``,
``e2c``, ``e2o``) and 2 when using comparisons involving individual ensemble
members (``m2c``, ``m2m``, ``m2o``). See
:py:func:`~climpred.metrics._get_norm_factor`.
.. note::
Because of the square root involved, any negative ``MSESS`` values are
automatically converted to NaNs.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
comparison: Name comparison needed for normalization factor ``fac``, see
:py:func:`~climpred.metrics._get_norm_factor`
(Handled internally by the compute functions)
metric_kwargs: see :py:func:`.xskillscore.mse`
Notes:
+----------------------------+-----------+
| **minimum** | 0.0 |
+----------------------------+-----------+
| **maximum** | 1.0 |
+----------------------------+-----------+
| **perfect** | 1.0 |
+----------------------------+-----------+
| **orientation** | positive |
+----------------------------+-----------+
| **better than climatology**| > 0.0 |
+----------------------------+-----------+
| **equal to climatology** | 0.0 |
+----------------------------+-----------+
References:
* :cite:t:`Murphy1988`
* :cite:t:`Bushuk2018`
Example:
>>> HindcastEnsemble.verify(
... metric="uacc", comparison="e2o", alignment="same_verifs", dim="init"
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.9093 0.9041 0.8849 0.877 ... 0.6894 0.5702 0.4763
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: uacc
comparison: e2o
dim: init
reference: []
"""
messs_res = _msess(forecast, verif, dim=dim, **metric_kwargs)
# Negative values are automatically turned into nans from xarray.
uacc_res = messs_res ** 0.5
return uacc_res
__uacc = Metric(
name="uacc",
function=_uacc,
positive=True,
probabilistic=False,
unit_power=0,
long_name="Bushuk's unbiased ACC",
minimum=0.0,
maximum=1.0,
perfect=1.0,
normalize=True,
)
##############################
# MURPHY DECOMPOSITION METRICS
##############################
[docs]def _std_ratio(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Ratio of standard deviations of the forecast over the verification data.
.. math:: \text{std ratio} = \frac{\sigma_f}{\sigma_o},
where :math:`\sigma_{f}` and :math:`\sigma_{o}` are the standard deviations of the
forecast and the verification data over the experimental period, respectively.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see xarray.std
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | N/A |
+-----------------+-----------+
References:
* https://www-miklip.dkrz.de/about/murcss/
Example:
>>> HindcastEnsemble.verify(
... metric="std_ratio",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.7567 0.8801 0.9726 1.055 ... 1.075 1.094 1.055
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: std_ratio
comparison: e2o
dim: init
reference: []
"""
return forecast.std(dim=dim, **metric_kwargs) / verif.std(dim=dim, **metric_kwargs)
__std_ratio = Metric(
name="std_ratio",
function=_std_ratio,
positive=None,
probabilistic=False,
unit_power=0,
long_name="Ratio of standard deviations of the forecast and verification data",
minimum=0.0,
maximum=np.inf,
perfect=1.0,
)
[docs]def _unconditional_bias(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Unconditional additive bias.
.. math::
\text{bias} = f - o
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over
metric_kwargs: see xarray.mean
Notes:
+-----------------+-----------+
| **minimum** | -∞ |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
References:
* https://www.cawcr.gov.au/projects/verification/
* https://www-miklip.dkrz.de/about/murcss/
Example:
>>> HindcastEnsemble.verify(
... metric="unconditional_bias",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 -0.01158 -0.02512 -0.0408 ... -0.1322 -0.1445
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: unconditional_bias
comparison: e2o
dim: init
reference: []
Conditional bias is removed by
:py:meth:`.HindcastEnsemble.remove_bias`.
>>> HindcastEnsemble = HindcastEnsemble.remove_bias(alignment="same_verifs")
>>> HindcastEnsemble.verify(
... metric="unconditional_bias",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 3.203e-18 -1.068e-18 ... 2.882e-17 -2.776e-17
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: unconditional_bias
comparison: e2o
dim: init
reference: []
"""
return (forecast - verif).mean(dim=dim, **metric_kwargs)
__unconditional_bias = Metric(
name="unconditional_bias",
function=_unconditional_bias,
positive=False,
probabilistic=False,
unit_power=1,
long_name="Unconditional additive bias",
aliases=["u_b", "a_b", "bias", "additive_bias"],
minimum=-np.inf,
maximum=np.inf,
perfect=0.0,
)
[docs]def _mul_bias(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""
Multiplicative bias.
.. math::
\text{multiplicative bias} = f / o
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over
metric_kwargs: see xarray.mean
Notes:
+-----------------+-----------+
| **minimum** | -∞ |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | None |
+-----------------+-----------+
Example:
>>> HindcastEnsemble.verify(
... metric="multiplicative_bias",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.719 0.9991 1.072 1.434 ... 1.854 2.128 2.325 2.467
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: mul_bias
comparison: e2o
dim: init
reference: []
"""
return (forecast / verif).mean(dim=dim, **metric_kwargs)
__mul_bias = Metric(
name="mul_bias",
function=_mul_bias,
positive=False,
probabilistic=False,
unit_power=0,
long_name="Multiplicative bias",
aliases=["m_b", "multiplicative_bias"],
minimum=-np.inf,
maximum=np.inf,
perfect=False,
)
[docs]def _conditional_bias(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Conditional bias between forecast and verification data.
.. math::
\text{conditional bias} = r_{fo} - \frac{\sigma_f}{\sigma_o},
where :math:`\sigma_{f}` and :math:`\sigma_{o}` are the standard deviations of the
forecast and verification data over the experimental period, respectively.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.pearson_r`
and :py:meth:`~.xarray.Dataset.std`
Notes:
+-----------------+-----------+
| **minimum** | -∞ |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
References:
https://www-miklip.dkrz.de/about/murcss/
Example:
>>> HindcastEnsemble.verify(
... metric="conditional_bias",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.1705 0.03435 -0.05988 ... -0.1436 -0.175 -0.1434
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: conditional_bias
comparison: e2o
dim: init
reference: []
"""
acc = _pearson_r(forecast, verif, dim=dim, **metric_kwargs)
return acc - _std_ratio(forecast, verif, dim=dim, **metric_kwargs)
__conditional_bias = Metric(
name="conditional_bias",
function=_conditional_bias,
positive=False,
probabilistic=False,
unit_power=0,
long_name="Conditional bias",
aliases=["c_b", "cond_bias"],
minimum=-np.inf,
maximum=1.0,
perfect=0.0,
)
[docs]def _bias_slope(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Bias slope between verification data and forecast standard deviations.
.. math::
\text{bias slope} = \frac{s_{o}}{s_{f}} \cdot r_{fo},
where :math:`r_{fo}` is the Pearson product-moment correlation between the forecast
and the verification data and :math:`s_{o}` and :math:`s_{f}` are the standard
deviations of the verification data and forecast over the experimental period,
respectively.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.pearson_r` and
:py:meth:`~.xarray.Dataset.std`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
References:
https://www-miklip.dkrz.de/about/murcss/
Example:
>>> HindcastEnsemble.verify(
... metric="bias_slope",
... comparison="e2o",
... alignment="same_verifs",
... dim="init",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.7016 0.8049 0.8877 0.9836 ... 1.002 1.004 0.961
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: bias_slope
comparison: e2o
dim: init
reference: []
"""
std_ratio = _std_ratio(forecast, verif, dim=dim, **metric_kwargs)
acc = _pearson_r(forecast, verif, dim=dim, **metric_kwargs)
return std_ratio * acc
__bias_slope = Metric(
name="bias_slope",
function=_bias_slope,
positive=False,
probabilistic=False,
unit_power=0,
long_name="Bias slope",
minimum=0.0,
maximum=np.inf,
perfect=1.0,
)
[docs]def _msess_murphy(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Murphy's Mean Square Error Skill Score (MSESS).
.. math::
MSESS_{Murphy} = r_{fo}^2 - [\text{conditional bias}]^2 -\
[\frac{\text{(unconditional) bias}}{\sigma_o}]^2,
where :math:`r_{fo}^{2}` represents the Pearson product-moment correlation
coefficient between the forecast and verification data and :math:`\sigma_{o}`
represents the standard deviation of the verification data over the experimental
period. See ``conditional_bias`` and ``unconditional_bias`` for their respective
formulations.
Args:
forecast: Forecast.
verif: Verification data.
dim: Dimension(s) to perform metric over.
metric_kwargs: see :py:func:`.xskillscore.pearson_r`,
:py:meth:`~xarray.Dataset.mean` and :py:meth:`~.xarray.Dataset.std`
Notes:
+-----------------+-----------+
| **minimum** | -∞ |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | positive |
+-----------------+-----------+
See Also:
* :py:func:`~climpred.metrics._pearson_r`
* :py:func:`~climpred.metrics._conditional_bias`
* :py:func:`~climpred.metrics._unconditional_bias`
References:
* https://www-miklip.dkrz.de/about/murcss/
* :cite:t:`Murphy1988`
Example:
>>> HindcastEnsemble = HindcastEnsemble.remove_bias(alignment="same_verifs")
>>> HindcastEnsemble.verify(
... metric="msess_murphy",
... comparison="e2o",
... dim="init",
... alignment="same_verifs",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.8306 0.8351 0.8295 0.8532 ... 0.8471 0.813 0.8097
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: msess_murphy
comparison: e2o
dim: init
reference: []
"""
acc = _pearson_r(forecast, verif, dim=dim, **metric_kwargs)
conditional_bias = _conditional_bias(forecast, verif, dim=dim, **metric_kwargs)
uncond_bias = _unconditional_bias(
forecast, verif, dim=dim, **metric_kwargs
) / verif.std(dim=dim, **metric_kwargs)
return acc ** 2 - conditional_bias ** 2 - uncond_bias ** 2
__msess_murphy = Metric(
name="msess_murphy",
function=_msess_murphy,
positive=True,
probabilistic=False,
unit_power=0,
long_name="Murphy's Mean Square Error Skill Score",
aliases=["msss_murphy"],
minimum=-np.inf,
maximum=1.0,
perfect=1.0,
)
#######################
# PROBABILISTIC METRICS
#######################
[docs]def _brier_score(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
"""Brier Score for binary events.
The Mean Square Error (``mse``) of probabilistic two-category forecasts where the
verification data are either 0 (no occurrence) or 1 (occurrence) and forecast
probability may be arbitrarily distributed between occurrence and non-occurrence.
The Brier Score equals zero for perfect (single-valued) forecasts and one for
forecasts that are always incorrect.
.. math::
BS(f, o) = (f_1 - o)^2,
where :math:`f_1` is the forecast probability of :math:`o=1`.
.. note::
The Brier Score requires that the observation is binary, i.e., can be described
as one (a "hit") or zero (a "miss"). So either provide a function with
with binary outcomes ``logical`` in ``metric_kwargs`` or create binary
verifs and probability forecasts by `hindcast.map(logical).mean("member")`.
This Brier Score is not the original formula given in :cite:t:`Brier1950`.
Args:
forecast: Raw forecasts with ``member`` dimension if ``logical``
provided in `metric_kwargs`. Probability forecasts in ``[0, 1]`` if
``logical`` is not provided.
verif: Verification data without ``member`` dim. Raw verification if
``logical`` provided, else binary verification.
dim: Dimensions to aggregate. Requires ``member`` if ``logical``
provided in ``metric_kwargs``to create probability forecasts. If ``logical``
not provided in ``metric_kwargs``, should not include ``member``.
logical (callable): Function with bool result to be applied to verification
data and forecasts and then ``mean("member")`` to get forecasts and
verification data in interval ``[0, 1]``.
see :py:func:`.xskillscore.brier_score`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
References:
* https://www.nws.noaa.gov/oh/rfcdev/docs/Glossary_Forecast_Verification_Metrics.pdf
* https://en.wikipedia.org/wiki/Brier_score
* :cite:t:`Brier1950`
See also:
* :py:func:`.xskillscore.brier_score`
Example:
Define a boolean/logical: Function for binary scoring:
>>> def pos(x):
... return x > 0 # checking binary outcomes
...
Option 1. Pass with keyword ``logical``: (specifically designed for
:py:class:`.PerfectModelEnsemble`, where binary verification
can only be created after comparison)
>>> HindcastEnsemble.verify(
... metric="brier_score",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... logical=pos,
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.115 0.1121 0.1363 0.125 ... 0.1654 0.1675 0.1873
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: brier_score
comparison: m2o
dim: ['member', 'init']
reference: []
logical: Callable
Option 2. Pre-process to generate a binary multi-member forecast and
binary verification product:
>>> HindcastEnsemble.map(pos).verify(
... metric="brier_score",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.115 0.1121 0.1363 0.125 ... 0.1654 0.1675 0.1873
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: brier_score
comparison: m2o
dim: ['member', 'init']
reference: []
Option 3. Pre-process to generate a probability forecast and binary
verification product. because ``member`` not present in ``hindcast`` anymore,
use ``comparison="e2o"`` and ``dim="init"``:
>>> HindcastEnsemble.map(pos).mean("member").verify(
... metric="brier_score",
... comparison="e2o",
... dim="init",
... alignment="same_verifs",
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.115 0.1121 0.1363 0.125 ... 0.1654 0.1675 0.1873
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
alignment: same_verifs
metric: brier_score
comparison: e2o
dim: init
reference: []
"""
forecast, verif, metric_kwargs, dim = _extract_and_apply_logical(
forecast, verif, metric_kwargs, dim
)
forecast, dim = _maybe_member_mean_reduce_dim(forecast, dim)
assert (
"member" not in forecast.dims
) # require probabilities # TODO: allow fair=True
return brier_score(verif, forecast, dim=dim, **metric_kwargs)
__brier_score = Metric(
name="brier_score",
function=_brier_score,
positive=False,
probabilistic=True,
unit_power=0,
long_name="Brier Score",
aliases=["brier", "bs"],
minimum=0.0,
maximum=1.0,
perfect=0.0,
allows_logical=True,
)
[docs]def _threshold_brier_score(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Brier score of an ensemble for exceeding given thresholds.
.. math::
CRPS = \int_f BS(F(f), H(f - o)) df
where :math:`F(o) = \int_{f \leq o} p(f) df` is the cumulative distribution
function (CDF) of the forecast distribution :math:`F`, :math:`o` is a point estimate
of the true observation (observational error is neglected), :math:`BS` denotes the
Brier score and :math:`H(x)` denotes the Heaviside step function, which we define
here as equal to 1 for :math:`x \geq 0` and 0 otherwise.
Args:
forecast: Forecast with ``member`` dim.
verif: Verification data without ``member`` dim.
dim: Dimension to apply metric over. Expects at least
``member``. Other dimensions are passed to ``xskillscore`` and averaged.
threshold (int, float, xarray.Dataset, xr.DataArray): Threshold to check
exceedance, see :py:func:`.xskillscore.threshold_brier_score`.
metric_kwargs: optional, see :py:func:`.xskillscore.threshold_brier_score`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
References:
* :cite:t:`Brier1950`
See also:
* :py:func:`.xskillscore.threshold_brier_score`
Example:
>>> # get threshold brier score for each init
>>> HindcastEnsemble.verify(
... metric="threshold_brier_score",
... comparison="m2o",
... dim="member",
... threshold=0.2,
... alignment="same_inits",
... )
<xarray.Dataset>
Dimensions: (lead: 10, init: 52)
Coordinates:
* init (init) object 1954-01-01 00:00:00 ... 2005-01-01 00:00:00
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
valid_time (lead, init) object 1955-01-01 00:00:00 ... 2015-01-01 00:00:00
threshold float64 0.2
skill <U11 'initialized'
Data variables:
SST (lead, init) float64 0.0 0.0 0.0 0.0 0.0 ... 0.25 0.36 0.09 0.01
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_members: 10
alignment: same_inits
metric: threshold_brier_score
comparison: m2o
dim: member
reference: []
threshold: 0.2
>>> # multiple thresholds averaging over init dimension
>>> HindcastEnsemble.verify(
... metric="threshold_brier_score",
... comparison="m2o",
... dim=["member", "init"],
... threshold=[0.2, 0.3],
... alignment="same_verifs",
... )
<xarray.Dataset>
Dimensions: (lead: 10, threshold: 2)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
* threshold (threshold) float64 0.2 0.3
skill <U11 'initialized'
Data variables:
SST (lead, threshold) float64 0.08712 0.005769 ... 0.1312 0.01923
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: threshold_brier_score
comparison: m2o
dim: ['member', 'init']
reference: []
threshold: [0.2, 0.3]
"""
if "threshold" not in metric_kwargs:
raise ValueError("Please provide threshold.")
else:
threshold = metric_kwargs.pop("threshold")
dim = _remove_member_from_dim_or_raise(dim)
# switch args b/c xskillscore.threshold_brier_score(verif, forecasts)
return threshold_brier_score(verif, forecast, threshold, dim=dim, **metric_kwargs)
__threshold_brier_score = Metric(
name="threshold_brier_score",
function=_threshold_brier_score,
positive=False,
probabilistic=True,
unit_power=0,
long_name="Threshold Brier Score",
aliases=["tbs"],
minimum=0.0,
maximum=1.0,
perfect=0.0,
requires_member_dim=True,
)
[docs]def _crps(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Continuous Ranked Probability Score (CRPS).
The CRPS can also be considered as the probabilistic Mean Absolute Error (``mae``).
It compares the empirical distribution of an ensemble forecast to a scalar
observation. Smaller scores indicate better skill.
.. math::
CRPS = \int_{-\infty}^{\infty} (F(f) - H(f - o))^{2} df,
where :math:`F(f)` is the cumulative distribution function (CDF) of the forecast
(since the verification data are not assigned a probability), and H() is the
Heaviside step function where the value is 1 if the argument is positive (i.e., the
forecast overestimates verification data) or zero (i.e., the forecast equals
verification data) and is 0 otherwise (i.e., the forecast is less than verification
data).
.. note::
The CRPS is expressed in the same unit as the observed variable. It generalizes
the Mean Absolute Error (MAE), and reduces to the MAE if the forecast is
determinstic.
Args:
forecast: Forecast with ``member`` dim.
verif: Verification data without ``member`` dim.
dim: Dimension to apply metric over. Expects at least
``member``. Other dimensions are passed to ``xskillscore`` and averaged.
metric_kwargs: optional, see :py:func:`.xskillscore.crps_ensemble`
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
References:
* :cite:t:`Matheson1976`
* https://www.lokad.com/continuous-ranked-probability-score
See also:
* :py:func:`.xskillscore.crps_ensemble`
Example:
>>> HindcastEnsemble.verify(
... metric="crps", comparison="m2o", dim="member", alignment="same_inits"
... )
<xarray.Dataset>
Dimensions: (lead: 10, init: 52)
Coordinates:
* init (init) object 1954-01-01 00:00:00 ... 2005-01-01 00:00:00
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
valid_time (lead, init) object 1955-01-01 00:00:00 ... 2015-01-01 00:00:00
skill <U11 'initialized'
Data variables:
SST (lead, init) float64 0.1722 0.1202 0.01764 ... 0.05428 0.1638
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_members: 10
alignment: same_inits
metric: crps
comparison: m2o
dim: member
reference: []
"""
dim = _remove_member_from_dim_or_raise(dim)
# switch positions because xskillscore.crps_ensemble(verif, forecasts)
return crps_ensemble(verif, forecast, dim=dim, **metric_kwargs)
__crps = Metric(
name="crps",
function=_crps,
positive=False,
probabilistic=True,
unit_power=1.0,
long_name="Continuous Ranked Probability Score",
minimum=0.0,
maximum=np.inf,
perfect=0.0,
requires_member_dim=True,
)
def _crps_quadrature(
verification: xr.Dataset,
cdf_or_dist: Callable,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
"""Compute the continuously ranked probability score (CPRS).
For a given
forecast distribution (``cdf``) and observation (``o``) using numerical quadrature.
This implementation allows the computation of CRPSS for arbitrary forecast
distributions. If gaussianity can be assumed ``crps_gaussian`` is faster.
.. note::
This is a helper function for CRPS and cannot be called directly by a user.
Args:
forecast: Forecast with ``member`` dim.
cdf_or_dist (callable or :py:func:`.scipy.stats.distribution`): Function which
returns the cumulative density of the forecast distribution at value x.
metric_kwargs: see :py:func:`.xskillscore.crps_quadrature`
See also:
* :py:func:`.xskillscore.crps_quadrature`
"""
return crps_quadrature(verification, cdf_or_dist, dim=dim, **metric_kwargs)
[docs]def _crpss(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Continuous Ranked Probability Skill Score.
This can be used to assess whether the ensemble spread is a useful measure for the
forecast uncertainty by comparing the CRPS of the ensemble forecast to that of a
reference forecast with the desired spread.
.. math::
CRPSS = 1 - \frac{CRPS_{initialized}}{CRPS_{clim}}
.. note::
When assuming a Gaussian distribution of forecasts, use default
``gaussian=True``. If not gaussian, you may specify the distribution type,
``xmin/xmax/tolerance`` for integration
(see :py:func:`.xskillscore.crps_quadrature`).
Args:
forecast: Forecast with ``member`` dim.
verif: Verification data without ``member`` dim.
dim: Dimension to apply metric over. Expects at least
``member``. Other dimensions are passed to ``xskillscore`` and averaged.
gaussian (bool, optional): If ``True``, assume Gaussian distribution for
baseline skill. Defaults to ``True``.
see :py:func:`.xskillscore.crps_ensemble`,
:py:func:`.xskillscore.crps_gaussian` and
:py:func:`.xskillscore.crps_quadrature`
Notes:
+----------------------------+-----------+
| **minimum** | -∞ |
+----------------------------+-----------+
| **maximum** | 1.0 |
+----------------------------+-----------+
| **perfect** | 1.0 |
+----------------------------+-----------+
| **orientation** | positive |
+----------------------------+-----------+
| **better than climatology**| > 0.0 |
+----------------------------+-----------+
| **worse than climatology** | < 0.0 |
+----------------------------+-----------+
References:
* :cite:t:`Matheson1976`
* :cite:t:`Gneiting2007`
Example:
>>> HindcastEnsemble.verify(
... metric="crpss", comparison="m2o", alignment="same_inits", dim="member"
... )
<xarray.Dataset>
Dimensions: (init: 52, lead: 10)
Coordinates:
* init (init) object 1954-01-01 00:00:00 ... 2005-01-01 00:00:00
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
valid_time (lead, init) object 1955-01-01 00:00:00 ... 2015-01-01 00:00:00
skill <U11 'initialized'
Data variables:
SST (lead, init) float64 0.2644 0.3636 0.7376 ... 0.7702 0.5126
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_members: 10
alignment: same_inits
metric: crpss
comparison: m2o
dim: member
reference: []
>>> import scipy
>>> PerfectModelEnsemble.isel(lead=[0, 1]).verify(
... metric="crpss",
... comparison="m2m",
... dim="member",
... gaussian=False,
... cdf_or_dist=scipy.stats.norm,
... xmin=-10,
... xmax=10,
... tol=1e-6,
... ) # doctest: +SKIP
<xarray.Dataset>
Dimensions: (init: 12, lead: 2, member: 9)
Coordinates:
* init (init) object 3014-01-01 00:00:00 ... 3257-01-01 00:00:00
* lead (lead) int64 1 2
* member (member) int64 1 2 3 4 5 6 7 8 9
Data variables:
tos (lead, init, member) float64 0.9931 0.9932 0.9932 ... 0.9947 0.9947
See also:
* :py:func:`.xskillscore.crps_ensemble`
"""
if dim is None:
dim = list(verif.dims)
if isinstance(dim, str):
dim = list(dim)
# available climpred dimensions to take mean and std over
rdim = [tdim for tdim in verif.dims if tdim in CLIMPRED_DIMS]
mu = verif.mean(rdim)
sig = verif.std(rdim)
# checking metric_kwargs, if not found use defaults: gaussian, else crps_quadrature
gaussian = metric_kwargs.pop("gaussian", True)
# dim="member" only for crps_gaussian, remove member for crps_gaussian/quadrature
dim_for_gaussian = dim.copy()
dim_for_gaussian.remove("member")
if gaussian:
ref_skill = crps_gaussian(verif, mu, sig, dim=dim_for_gaussian, **metric_kwargs)
else:
cdf_or_dist = metric_kwargs.pop("cdf_or_dist", norm)
xmin = metric_kwargs.pop("xmin", None)
xmax = metric_kwargs.pop("xmax", None)
tol = metric_kwargs.pop("tol", 1e-6)
ref_skill = _crps_quadrature(
forecast,
cdf_or_dist,
xmin=xmin,
xmax=xmax,
tol=tol,
dim=dim_for_gaussian,
**metric_kwargs,
)
forecast_skill = _crps(forecast, verif, dim=dim, **metric_kwargs)
skill_score = 1 - forecast_skill / ref_skill
return skill_score
__crpss = Metric(
name="crpss",
function=_crpss,
positive=True,
probabilistic=True,
unit_power=0,
long_name="Continuous Ranked Probability Skill Score",
minimum=-np.inf,
maximum=1.0,
perfect=1.0,
requires_member_dim=True,
)
[docs]def _crpss_es(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Continuous Ranked Probability Skill Score Ensemble Spread.
If the ensemble variance is smaller than the observed ``mse``, the ensemble is
said to be under-dispersive (or overconfident). An ensemble with variance larger
than the verification data indicates one that is over-dispersive (underconfident).
.. math::
CRPSS = 1 - \frac{CRPS(\sigma^2_f)}{CRPS(\sigma^2_o)}
Args:
forecast: Forecast with ``member`` dim.
verif: Verification data without ``member`` dim.
dim: Dimension to apply metric over. Expects at least
``member``. Other dimensions are passed to ``xskillscore`` and averaged.
metric_kwargs: see :py:func:`.xskillscore.crps_ensemble`
and :py:func:`.xskillscore.mse`
Notes:
+----------------------------+-----------+
| **minimum** | -∞ |
+----------------------------+-----------+
| **maximum** | 0.0 |
+----------------------------+-----------+
| **perfect** | 0.0 |
+----------------------------+-----------+
| **orientation** | positive |
+----------------------------+-----------+
| **under-dispersive** | > 0.0 |
+----------------------------+-----------+
| **over-dispersive** | < 0.0 |
+----------------------------+-----------+
References:
* :cite:t:`Kadow2016`
Example:
>>> HindcastEnsemble.verify(
... metric="crpss_es",
... comparison="m2o",
... alignment="same_verifs",
... dim="member",
... )
<xarray.Dataset>
Dimensions: (init: 52, lead: 10)
Coordinates:
* init (init) object 1964-01-01 00:00:00 ... 2015-01-01 00:00:00
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
valid_time (init) object 1964-01-01 00:00:00 ... 2015-01-01 00:00:00
skill <U11 'initialized'
Data variables:
SST (lead, init) float64 -0.01121 -0.05575 ... -0.1263 -0.007483
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_members: 10
alignment: same_verifs
metric: crpss_es
comparison: m2o
dim: member
reference: []
"""
if dim is None:
dim = verif.dims
# helper dim to calc mu
rdim = [d for d in verif.dims if d in CLIMPRED_DIMS]
mu = verif.mean(rdim)
# forecast, verif_member = xr.broadcast(forecast, verif)
dim_no_member = [d for d in dim if d != "member"]
ensemble_spread = forecast.std("member").mean(dim=dim_no_member, **metric_kwargs)
if forecast.member.size == 1:
warnings.warn(
f"Ensemble spread is 0 because only {forecast.member.size} members."
"`CRPSS_ES` yields NaNs for persistence and climatology reference skill."
)
mse_h = _mse(forecast.mean("member"), verif, dim=dim_no_member, **metric_kwargs)
crps_h = crps_gaussian(verif, mu, mse_h, dim=dim_no_member, **metric_kwargs)
crps_r = crps_gaussian(
verif, mu, ensemble_spread, dim=dim_no_member, **metric_kwargs
)
res = 1 - crps_h / crps_r
if "time" in res.dims:
res = res.rename({"time": "init"})
return res
__crpss_es = Metric(
name="crpss_es",
function=_crpss_es,
positive=True,
probabilistic=True,
unit_power=0,
long_name="CRPSS Ensemble Spread",
minimum=-np.inf,
maximum=0.0,
perfect=0.0,
requires_member_dim=True,
)
[docs]def _discrimination(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
"""
Discrimination.
Return 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.
Args:
forecast: Raw forecasts with ``member`` dimension if ``logical``
provided in `metric_kwargs`. Probability forecasts in [0, 1] if ``logical``
is not provided.
verif: Verification data without ``member`` dim. Raw verification if
``logical`` provided, else binary verification.
dim: Dimensions to aggregate. Requires ``member`` if ``logical``
provided in ``metric_kwargs`` to create probability forecasts.
If ``logical`` not provided in ``metric_kwargs``, should not include
``member``. At least one dimension other than ``member``is required.
logical: Function with bool result to be applied to
verification data and forecasts and then ``mean("member")`` to get
forecasts and verification data in interval ``[0, 1]``.
Passed via ``metric_kwargs``.
probability_bin_edges (array_like, optional): Probability bin edges used to
compute the histograms. Bins include the left most edge, but not the
right. Passed via ``metric_kwargs``.
Defaults to 6 equally spaced edges between ``0`` and ``1+1e-8``.
Returns:
Discrimination with added dimension ``event`` containing the histograms of
forecast probabilities when the event was observed and not observed.
Notes:
+-----------------+------------------------+
| **perfect** | distinct distributions |
+-----------------+------------------------+
See also:
* :py:func:`.xskillscore.discrimination`
Example:
Define a boolean/logical: Function for binary scoring:
>>> def pos(x):
... return x > 0 # checking binary outcomes
...
Option 1. Pass with keyword ``logical``: (especially designed for
:py:class:`.PerfectModelEnsemble`, where binary verification
can only be created after comparison)
>>> HindcastEnsemble.verify(
... metric="discrimination",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... logical=pos,
... )
<xarray.Dataset>
Dimensions: (lead: 10, forecast_probability: 5, event: 2)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
* forecast_probability (forecast_probability) float64 0.1 0.3 0.5 0.7 0.9
* event (event) bool True False
skill <U11 'initialized'
Data variables:
SST (lead, event, forecast_probability) float64 0.07407...
Option 2. Pre-process to generate a binary forecast and verification product:
>>> HindcastEnsemble.map(pos).verify(
... metric="discrimination",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... )
<xarray.Dataset>
Dimensions: (lead: 10, forecast_probability: 5, event: 2)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
* forecast_probability (forecast_probability) float64 0.1 0.3 0.5 0.7 0.9
* event (event) bool True False
skill <U11 'initialized'
Data variables:
SST (lead, event, forecast_probability) float64 0.07407...
Option 3. Pre-process to generate a probability forecast and binary
verification product. because ``member`` not present in ``hindcast``, use
``comparison="e2o"`` and ``dim="init"``:
>>> HindcastEnsemble.map(pos).mean("member").verify(
... metric="discrimination",
... comparison="e2o",
... dim="init",
... alignment="same_verifs",
... )
<xarray.Dataset>
Dimensions: (lead: 10, forecast_probability: 5, event: 2)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
* forecast_probability (forecast_probability) float64 0.1 0.3 0.5 0.7 0.9
* event (event) bool True False
skill <U11 'initialized'
Data variables:
SST (lead, event, forecast_probability) float64 0.07407...
"""
forecast, verif, metric_kwargs, dim = _extract_and_apply_logical(
forecast, verif, metric_kwargs, dim
)
forecast, dim = _maybe_member_mean_reduce_dim(forecast, dim)
assert "member" not in forecast.dims # requires probabilities
return discrimination(verif, forecast, dim=dim, **metric_kwargs)
__discrimination = Metric(
name="discrimination",
function=_discrimination,
positive=None,
probabilistic=True,
unit_power=0,
long_name="Discrimination",
allows_logical=True,
)
[docs]def _reliability(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
"""
Reliability.
Returns the data required to construct the reliability diagram for an event. The
the relative frequencies of occurrence of an event for a range of forecast
probability bins.
Args:
forecast: Raw forecasts with ``member`` dimension if ``logical``
provided in ``metric_kwargs``. Probability forecasts in ``[0, 1]`` if
``logical`` is not provided.
verif: Verification data without ``member`` dim. Raw verification if
``logical`` provided, else binary verification.
dim: Dimensions to aggregate. Requires ``member`` if ``logical``
provided in ``metric_kwargs``to create probability forecasts. If ``logical``
not provided in ``metric_kwargs``, should not include ``member``.
logical: Function with bool result to be applied to
verification data and forecasts and then ``mean("member")`` to get
forecasts and verification data in interval ``[0, 1]``.
Passed via ``metric_kwargs``.
probability_bin_edges (array_like, optional): Probability bin edges used to
compute the reliability. Bins include the left most edge, but not the
right. Passed via ``metric_kwargs``. Defaults to 6 equally spaced edges
between ``0`` and ``1+1e-8``.
Returns:
reliability: The relative frequency of occurrence for each probability bin
Notes:
+-----------------+-------------------+
| **perfect** | flat distribution |
+-----------------+-------------------+
See also:
* :py:func:`.xskillscore.reliability`
Example:
Define a boolean/logical: Function for binary scoring:
>>> def pos(x):
... return x > 0 # checking binary outcomes
...
Option 1. Pass with keyword ``logical``: (especially designed for
:py:class:`.PerfectModelEnsemble`, where binary verification
can only be created after comparison))
>>> HindcastEnsemble.verify(
... metric="reliability",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... logical=pos,
... )
<xarray.Dataset>
Dimensions: (lead: 10, forecast_probability: 5)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
* forecast_probability (forecast_probability) float64 0.1 0.3 0.5 0.7 0.9
SST_samples (lead, forecast_probability) float64 22.0 5.0 ... 13.0
skill <U11 'initialized'
Data variables:
SST (lead, forecast_probability) float64 0.09091 ... 1.0
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: reliability
comparison: m2o
dim: ['member', 'init']
reference: []
logical: Callable
Option 2. Pre-process to generate a binary forecast and verification product:
>>> HindcastEnsemble.map(pos).verify(
... metric="reliability",
... comparison="m2o",
... dim=["init", "member"],
... alignment="same_verifs",
... )
<xarray.Dataset>
Dimensions: (lead: 10, forecast_probability: 5)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
* forecast_probability (forecast_probability) float64 0.1 0.3 0.5 0.7 0.9
SST_samples (lead, forecast_probability) float64 22.0 5.0 ... 13.0
skill <U11 'initialized'
Data variables:
SST (lead, forecast_probability) float64 0.09091 ... 1.0
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: reliability
comparison: m2o
dim: ['init', 'member']
reference: []
Option 3. Pre-process to generate a probability forecast and binary
verification product. because ``member`` not present in ``hindcast``, use
``comparison="e2o"`` and ``dim="init"``:
>>> HindcastEnsemble.map(pos).mean("member").verify(
... metric="reliability",
... comparison="e2o",
... dim="init",
... alignment="same_verifs",
... )
<xarray.Dataset>
Dimensions: (lead: 10, forecast_probability: 5)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
* forecast_probability (forecast_probability) float64 0.1 0.3 0.5 0.7 0.9
SST_samples (lead, forecast_probability) float64 22.0 5.0 ... 13.0
skill <U11 'initialized'
Data variables:
SST (lead, forecast_probability) float64 0.09091 ... 1.0
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
alignment: same_verifs
metric: reliability
comparison: e2o
dim: init
reference: []
"""
if "logical" in metric_kwargs:
forecast, verif, metric_kwargs, dim = _extract_and_apply_logical(
forecast, verif, metric_kwargs, dim
)
forecast, dim = _maybe_member_mean_reduce_dim(forecast, dim)
assert "member" not in forecast.dims # requires probabilities
return reliability(verif, forecast, dim=dim, **metric_kwargs)
__reliability = Metric(
name="reliability",
function=_reliability,
positive=None,
probabilistic=True,
unit_power=0,
long_name="Reliability",
)
[docs]def _rank_histogram(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
"""Rank histogram or Talagrand diagram.
Args:
forecast: Raw forecasts with ``member`` dimension.
verif: Verification data without ``member`` dim.
dim: Dimensions to aggregate. Requires to contain ``member`` and at
least one additional dimension.
Notes:
+-----------------+------------------------------+
| **flat** | perfect |
+-----------------+------------------------------+
| **slope** | biased |
+-----------------+------------------------------+
| **u-shaped** | overconfident/underdisperive |
+-----------------+------------------------------+
| **dome-shaped** | underconfident/overdisperive |
+-----------------+------------------------------+
See also:
* :py:func:`.xskillscore.rank_histogram`
Example:
>>> HindcastEnsemble.verify(
... metric="rank_histogram",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... )
<xarray.Dataset>
Dimensions: (lead: 10, rank: 11)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
* rank (rank) float64 1.0 2.0 3.0 4.0 5.0 6.0 7.0 8.0 9.0 10.0 11.0
skill <U11 'initialized'
Data variables:
SST (lead, rank) int64 12 3 2 1 1 3 1 2 6 5 16 ... 0 1 0 0 3 0 2 6 6 34
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: rank_histogram
comparison: m2o
dim: ['member', 'init']
reference: []
>>> PerfectModelEnsemble.verify(
... metric="rank_histogram", comparison="m2c", dim=["member", "init"]
... )
<xarray.Dataset>
Dimensions: (lead: 20, rank: 10)
Coordinates:
* lead (lead) int64 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
* rank (rank) float64 1.0 2.0 3.0 4.0 5.0 6.0 7.0 8.0 9.0 10.0
Data variables:
tos (lead, rank) int64 1 4 2 1 2 1 0 0 0 1 2 ... 0 2 0 1 2 1 0 3 1 2 0
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: PerfectModelEnsemble.verify()
number_of_initializations: 12
number_of_members: 10
metric: rank_histogram
comparison: m2c
dim: ['member', 'init']
reference: []
"""
dim = _remove_member_from_dim_or_raise(dim)
return rank_histogram(verif, forecast, dim=dim, **metric_kwargs)
__rank_histogram = Metric(
name="rank_histogram",
function=_rank_histogram,
positive=None,
probabilistic=True,
unit_power=0,
long_name="rank_histogram",
requires_member_dim=True,
)
[docs]def _rps(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""Ranked Probability Score.
.. math::
RPS(p, k) = \sum_{m=1}^{M} [(\sum_{k=1}^{m} p_k) - (\sum_{k=1}^{m} \
o_k)]^{2}
Args:
forecast: Forecasts.
verif: Verification.
dim: Dimensions to aggregate.
**metric_kwargs, see :py:func:`.xskillscore.rps`
.. note::
If ``category_edges`` is xr.Dataset or tuple of xr.Datasets, climpred will
broadcast the grouped dimensions ``season``, ``month``, ``weekofyear``,
``dayfofyear`` onto the dimensions ``init`` for forecast and ``time`` for
observations. see ``climpred.utils.broadcast_time_grouped_to_time``.
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | ∞ |
+-----------------+-----------+
| **perfect** | 0.0 |
+-----------------+-----------+
| **orientation** | negative |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.rps`
Example:
>>> category_edges = np.array([-0.5, 0.0, 0.5, 1.0])
>>> HindcastEnsemble.verify(
... metric="rps",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... category_edges=category_edges,
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
observations_category_edge <U67 '[-np.inf, -0.5), [-0.5, 0.0), [0.0, 0.5...
forecasts_category_edge <U67 '[-np.inf, -0.5), [-0.5, 0.0), [0.0, 0.5...
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.115 0.1123 ... 0.1687 0.1875
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: rps
comparison: m2o
dim: ['member', 'init']
reference: []
category_edges: [-0.5 0. 0.5 1. ]
Provide ``category_edges`` as :py:class:`xarray.Dataset` for category edges
varying along dimensions.
>>> category_edges = (
... xr.DataArray([9.5, 10.0, 10.5, 11.0], dims="category_edge")
... .assign_coords(category_edge=[9.5, 10.0, 10.5, 11.0])
... .to_dataset(name="tos")
... )
>>> # category_edges = np.array([9.5, 10., 10.5, 11.]) # identical
>>> PerfectModelEnsemble.verify(
... metric="rps",
... comparison="m2c",
... dim=["member", "init"],
... category_edges=category_edges,
... )
<xarray.Dataset>
Dimensions: (lead: 20)
Coordinates:
* lead (lead) int64 1 2 3 4 5 6 7 ... 15 16 17 18 19 20
observations_category_edge <U71 '[-np.inf, 9.5), [9.5, 10.0), [10.0, 10....
forecasts_category_edge <U71 '[-np.inf, 9.5), [9.5, 10.0), [10.0, 10....
Data variables:
tos (lead) float64 0.08951 0.1615 ... 0.1399 0.2274
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: PerfectModelEnsemble.verify()
number_of_initializations: 12
number_of_members: 10
metric: rps
comparison: m2c
dim: ['member', 'init']
reference: []
category_edges: <xarray.Dataset>\nDimensions: (cate...
Provide ``category_edges`` as tuple for different category edges to categorize
forecasts and observations.
>>> q = [1 / 3, 2 / 3] # terciles by month
>>> forecast_edges = (
... HindcastEnsemble.get_initialized()
... .groupby("init.month")
... .quantile(q=q, dim=["init", "member"])
... .rename({"quantile": "category_edge"})
... )
>>> obs_edges = (
... HindcastEnsemble.get_observations()
... .groupby("time.month")
... .quantile(q=q, dim="time")
... .rename({"quantile": "category_edge"})
... )
>>> category_edges = (obs_edges, forecast_edges)
>>> HindcastEnsemble.verify(
... metric="rps",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... category_edges=category_edges,
... )
<xarray.Dataset>
Dimensions: (lead: 10)
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
observations_category_edge <U101 '[-np.inf, 0.3333333333333333), [0.3333...
forecasts_category_edge <U101 '[-np.inf, 0.3333333333333333), [0.3333...
skill <U11 'initialized'
Data variables:
SST (lead) float64 0.1248 0.1756 ... 0.3081 0.3413
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: HindcastEnsemble.verify()
number_of_initializations: 64
number_of_members: 10
alignment: same_verifs
metric: rps
comparison: m2o
dim: ['member', 'init']
reference: []
category_edges: (<xarray.Dataset>\nDimensions: (mon...
"""
if "category_edges" in metric_kwargs:
category_edges = metric_kwargs.pop("category_edges")
else:
category_edges = None
if (
category_edges is not None and "member" in forecast.dims
): # expect multiple member deterministic forecasts
dim = _remove_member_from_dim_or_raise(dim)
elif (
"category" in forecast.dims and "category" in verif.dims
): # expect multiple category in forecast and verif
pass
else:
raise ValueError(
"rps either expects multiple forecast members and `category_edges` or "
"`category` in both forecast and observations. Found: "
f"category_edges={category_edges}, forecast.dims = {forecast.dims}, "
f"observations.dims = {verif.dims}"
)
# get corresponding category_edges for lead
if "lead" not in forecast.dims and "lead" in forecast.coords and "lead":
if isinstance(category_edges, tuple):
if "lead" in category_edges[1].dims:
forecast_edges = (
category_edges[1].sel(lead=forecast.lead).rename({"init": "time"})
)
# shift category_edges by lead
from climpred.utils import my_shift
forecast_edges["time"] = my_shift(forecast_edges.time, forecast.lead)
forecast_edges = forecast_edges.sel(time=forecast.time)
forecast_edges = forecast_edges.assign_coords(time=forecast.time)
verif_edges = category_edges[0]
category_edges = (verif_edges, forecast_edges)
return rps(verif, forecast, category_edges, dim=dim, **metric_kwargs)
__rps = Metric(
name="rps",
function=_rps,
positive=False,
probabilistic=True,
unit_power=0,
long_name="ranked probability score",
minimum=0.0,
maximum=1.0,
perfect=0.0,
requires_member_dim=True,
)
[docs]def _contingency(forecast, verif, score="table", dim=None, **metric_kwargs):
"""Contingency table.
Args:
forecast: Raw forecasts.
verif: Verification data.
dim: Dimensions to aggregate.
score (str): Score derived from contingency table. Attribute from
:py:class:`~xskillscore.Contingency`. Use ``score=table`` to return a contingency table
or any other contingency score, e.g. ``score=hit_rate``.
observation_category_edges (array_like): Category bin edges used to compute
the observations CDFs. Bins include the left most edge, but not the right.
Passed via ``metric_kwargs``.
forecast_category_edges (array_like): Category bin edges used to compute
the forecast CDFs. Bins include the left most edge, but not the right.
Passed via metric_kwargs
See also:
* :py:class:`~xskillscore.Contingency`
* http://www.cawcr.gov.au/projects/verification/
* https://xskillscore.readthedocs.io/en/stable/api.html#contingency-based-metrics # noqa
Example:
>>> category_edges = np.array([-0.5, 0.0, 0.5, 1.0])
>>> HindcastEnsemble.verify(
... metric="contingency",
... score="table",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... observation_category_edges=category_edges,
... forecast_category_edges=category_edges,
... ).isel(lead=[0, 1]).SST
<xarray.DataArray 'SST' (lead: 2, observations_category: 3, forecasts_category: 3)>
array([[[221, 29, 0],
[ 53, 217, 0],
[ 0, 0, 0]],
<BLANKLINE>
[[234, 16, 0],
[ 75, 194, 1],
[ 0, 0, 0]]])
Coordinates:
* lead (lead) int32 1 2
observations_category_bounds (observations_category) <U11 '[-0.5, 0.0)' ...
forecasts_category_bounds (forecasts_category) <U11 '[-0.5, 0.0)' ......
* observations_category (observations_category) int64 1 2 3
* forecasts_category (forecasts_category) int64 1 2 3
skill <U11 'initialized'
Attributes:
units: None
>>> # contingency-based dichotomous accuracy score
>>> category_edges = np.array([9.5, 10.0, 10.5])
>>> PerfectModelEnsemble.verify(
... metric="contingency",
... score="hit_rate",
... comparison="m2c",
... dim=["member", "init"],
... observation_category_edges=category_edges,
... forecast_category_edges=category_edges,
... )
<xarray.Dataset>
Dimensions: (lead: 20)
Coordinates:
* lead (lead) int64 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
Data variables:
tos (lead) float64 1.0 1.0 1.0 1.0 0.9091 ... 1.0 1.0 1.0 nan 1.0
Attributes:
prediction_skill_software: climpred https://climpred.readthedocs.io/
skill_calculated_by_function: PerfectModelEnsemble.verify()
number_of_initializations: 12
number_of_members: 10
metric: contingency
comparison: m2c
dim: ['member', 'init']
reference: []
score: hit_rate
observation_category_edges: [ 9.5 10. 10.5]
forecast_category_edges: [ 9.5 10. 10.5]
"""
# contingency fails when given empty dimension, therefore add fake dimension
if dim == []:
forecast = forecast.expand_dims("member")
verif = verif.expand_dims("member")
dim = "member"
if score == "table":
return Contingency(verif, forecast, dim=dim, **metric_kwargs).table
else:
return getattr(Contingency(verif, forecast, dim=dim, **metric_kwargs), score)()
__contingency = Metric(
name="contingency",
function=_contingency,
positive=None,
probabilistic=False,
unit_power=0,
)
[docs]def _roc(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
"""Receiver Operating Characteristic.
Args:
observations: Labeled array(s) over which to apply the function.
If ``bin_edges=="continuous"``, observations are binary.
forecasts: Labeled array(s) over which to apply the function.
If ``bin_edges=="continuous"``, forecasts are probabilities.
dim: The dimension(s) over which to aggregate. Defaults to
None, meaning aggregation over all dims other than ``lead``.
logical: Function with bool result to be applied to
verification data and forecasts and then ``mean("member")`` to get
forecasts and verification data in interval ``[0, 1]``. Passed via ``metric_kwargs``.
bin_edges (array_like, str): Bin edges for categorising observations and
forecasts. Similar to np.histogram, all but the last (righthand-most) bin
include the left edge and exclude the right edge. The last bin includes
both edges. ``bin_edges`` will be sorted in ascending order. If
``bin_edges=="continuous"``, calculate ``bin_edges`` from forecasts, equal
to ``sklearn.metrics.roc_curve(f_boolean, o_prob)``. Passed via
``metric_kwargs``. Defaults to "continuous".
drop_intermediate (bool): Whether to drop some suboptimal thresholds which would
not appear on a plotted ROC curve. This is useful in order to create lighter
ROC curves. Defaults to ``False``. Defaults to ``True`` in
``sklearn.metrics.roc_curve``. Passed via ``metric_kwargs``.
return_results (str): Passed via ``metric_kwargs``. Defaults to "area".
Specify how return is structed:
- "area": return only the ``area under curve`` of ROC
- "all_as_tuple": return ``true positive rate`` and ``false positive rate``
at each bin and area under the curve of ROC as tuple
- "all_as_metric_dim": return ``true positive rate`` and
``false positive rate`` at each bin and ``area under curve`` of ROC
concatinated into new ``metric`` dimension
Returns:
reduced by dimensions ``dim``, see ``return_results``
parameter. ``true positive rate`` and ``false positive rate`` contain
``probability_bin`` dimension with ascending ``bin_edges`` as coordinates.
Notes:
+-----------------+-----------+
| **minimum** | 0.0 |
+-----------------+-----------+
| **maximum** | 1.0 |
+-----------------+-----------+
| **perfect** | 1.0 |
+-----------------+-----------+
| **orientation** | positive |
+-----------------+-----------+
See also:
* :py:func:`.xskillscore.roc`
* http://www.cawcr.gov.au/projects/verification/
* https://xskillscore.readthedocs.io/en/stable/api.html#roc # noqa
Example:
>>> bin_edges = np.array([-0.5, 0.0, 0.5, 1.0])
>>> HindcastEnsemble.verify(
... metric="roc",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... bin_edges=bin_edges,
... ).SST
<xarray.DataArray 'SST' (lead: 10)>
array([0.84385185, 0.82841667, 0.81358547, 0.8393463 , 0.82551752,
0.81987778, 0.80719573, 0.80081909, 0.79046553, 0.78037564])
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Attributes:
units: None
Get area under the curve, false positive rate and true positive rate as ``metric`` dimension by specifying ``return_results="all_as_metric_dim"``:
>>> def f(ds):
... return ds > 0
...
>>> HindcastEnsemble.map(f).verify(
... metric="roc",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... bin_edges="continuous",
... return_results="all_as_metric_dim",
... ).SST.isel(lead=[0, 1])
<xarray.DataArray 'SST' (lead: 2, metric: 3, probability_bin: 3)>
array([[[0. , 0.116 , 1. ],
[0. , 0.8037037 , 1. ],
[0.84385185, 0.84385185, 0.84385185]],
<BLANKLINE>
[[0. , 0.064 , 1. ],
[0. , 0.72222222, 1. ],
[0.82911111, 0.82911111, 0.82911111]]])
Coordinates:
* probability_bin (probability_bin) float64 2.0 1.0 0.0
* lead (lead) int32 1 2
* metric (metric) <U19 'false positive rate' ... 'area under curve'
skill <U11 'initialized'
Attributes:
units: None
"""
if "logical" in metric_kwargs:
forecast, verif, metric_kwargs, dim = _extract_and_apply_logical(
forecast, verif, metric_kwargs, dim
)
# roc fails when given empty dimension, therefore add fake dimension
if dim == []:
forecast = forecast.expand_dims("member")
verif = verif.expand_dims("member")
dim = "member"
return roc(verif, forecast, dim=dim, **metric_kwargs)
__roc = Metric(
name="roc",
function=_roc,
positive=True,
probabilistic=False,
unit_power=0,
aliases=["Receiver Operating Characteristic", "receiver_operating_characteristic"],
)
[docs]def _less(
forecast: xr.Dataset,
verif: xr.Dataset,
dim: dimType = None,
**metric_kwargs: metric_kwargsType,
) -> xr.Dataset:
r"""
Logarithmic Ensemble Spread Score.
.. math:: LESS = ln(\frac{variance}{MSE})= ln(\frac{\sigma^2_f}{\sigma^2_o})
Args:
forecast: Forecasts.
verif: Verification.
dim: The dimension(s) over which to aggregate. Defaults to
None, meaning aggregation over all dims other than ``lead``.
Returns:
less: reduced by dimensions ``dim``
Notes:
+-----------------+--------------------------------+
| **maximum** | ∞ |
+-----------------+--------------------------------+
| **positive** | overdisperive / underconfident |
+-----------------+--------------------------------+
| **perfect** | 0 |
+-----------------+--------------------------------+
| **negative** | underdisperive / overconfident |
+-----------------+--------------------------------+
| **minimum** | -∞ |
+-----------------+--------------------------------+
| **orientation** | None |
+-----------------+--------------------------------+
Example:
>>> # better detrend before
>>> from climpred.stats import rm_poly
>>> HindcastEnsemble.map(rm_poly, dim="init_or_time", deg=2).verify(
... metric="less",
... comparison="m2o",
... dim=["member", "init"],
... alignment="same_verifs",
... ).SST
<xarray.DataArray 'SST' (lead: 10)>
array([ 0.12633664, -0.12707636, -0.26143181, -0.25096537, -0.29267366,
-0.2905725 , -0.43579508, -0.33774947, -0.46008438, -0.61010386])
Coordinates:
* lead (lead) int32 1 2 3 4 5 6 7 8 9 10
skill <U11 'initialized'
Attributes:
units: None
References:
:cite:t:`Kadow2016`
"""
forecast, verif = xr.broadcast(forecast, verif)
numerator = _spread(forecast, verif, dim=dim, **metric_kwargs) ** 2
denominator = _mse(forecast, verif, dim=dim, **metric_kwargs)
return np.log(numerator / denominator)
__less = Metric(
name="less",
function=_less,
probabilistic=True,
positive=None,
unit_power=0,
long_name="Logarithmic Ensemble Spread Score",
minimum=-np.inf,
maximum=np.inf,
perfect=0.0,
requires_member_dim=True,
)
__ALL_METRICS__ = [
__pearson_r,
__spearman_r,
__pearson_r_p_value,
__effective_sample_size,
__pearson_r_eff_p_value,
__spearman_r_p_value,
__spearman_r_eff_p_value,
__mse,
__mae,
__rmse,
__median_absolute_error,
__mape,
__smape,
__msess_murphy,
__bias_slope,
__conditional_bias,
__unconditional_bias,
__brier_score,
__threshold_brier_score,
__crps,
__crpss,
__crpss_es,
__msess,
__nmse,
__nrmse,
__nmae,
__uacc,
__std_ratio,
__contingency,
__rank_histogram,
__discrimination,
__reliability,
__rps,
__roc,
__spread,
__mul_bias,
__less,
]
# To match a metric/comparison for (multiple) keywords.
METRIC_ALIASES = dict()
for m in __ALL_METRICS__:
if m.aliases is not None:
for a in m.aliases:
METRIC_ALIASES[a] = m.name
DETERMINISTIC_METRICS = [m.name for m in __ALL_METRICS__ if not m.probabilistic]
DETERMINISTIC_HINDCAST_METRICS = DETERMINISTIC_METRICS.copy()
# Metrics to be used in PerfectModelEnsemble
DETERMINISTIC_PM_METRICS = DETERMINISTIC_HINDCAST_METRICS.copy()
# Effective sample size does not make much sense in this framework.
DETERMINISTIC_PM_METRICS = [
e
for e in DETERMINISTIC_PM_METRICS
if e
not in (
"effective_sample_size",
"pearson_r_eff_p_value",
"spearman_r_eff_p_value",
)
]
# Used to set attrs['units'] to None.
DIMENSIONLESS_METRICS = [m.name for m in __ALL_METRICS__ if m.unit_power == 1]
# More positive skill is better than more negative.
POSITIVELY_ORIENTED_METRICS = [m.name for m in __ALL_METRICS__ if m.positive]
PROBABILISTIC_METRICS = [m.name for m in __ALL_METRICS__ if m.probabilistic]
# Combined allowed metrics for HindcastEnsemble.verify and PerfectModelEnsemble.verify
HINDCAST_METRICS = DETERMINISTIC_HINDCAST_METRICS + PROBABILISTIC_METRICS
PM_METRICS = DETERMINISTIC_PM_METRICS + PROBABILISTIC_METRICS
ALL_METRICS = [m.name for m in __ALL_METRICS__]
