Changelog History¶
xskillscore v0.0.17 (2020-09-06)
Features¶
Added contingency table and associated metrics (GH#119, GH#153). Dougie Squire
Added
rank_histogram()
anddiscrimination()
to probabilistic metrics (GH#136). Dougie SquireAdded
reliability()
to probabilistic metrics (GH#164). Dougie SquireAdded
dim
andweights
kwargs for probabilistic metrics. (GH#121) Aaron SpringAdded
keep_attrs
kwarg for all metrics. (GH#122) Andrew HuangAdded ranked probability score
rps()
. (GH#163) Aaron SpringDeterministic metrics now automatically broadcast any non-core dimensions. E.g., a single time series can be compared to a gridded product spanning that same time span. (GH#165, GH#71, GH#156, GH#166) Aaron Spring
Breaking Changes¶
Renamed
dim
tomember_dim
in probabilistic metrics. (GH#121) Aaron SpringArgument
dim
becomes keyworddim=None
in all metrics. (GH#137, GH#143) Aaron Springdim=None
reduces all dimensions as inxr.mean(dim=None)
. (GH#137, GH#143) Aaron Spring
Bug Fixes¶
Fixes
weights=None
type issue with latest version ofdask
. (GH#168, GH#171) Andrew Huang
Documentation¶
Added
sphinx
documentation with full API and a quick start notebook. (GH#127) Riley X. Brady and Ray Bell.
Internal Changes¶
Added
utils
module to house utilities shared across multiple modules (GH#119). Dougie SquireAdded
conftest.py
to gather allpytest.fixtures
. (GH#126, GH#159). Aaron Spring and Ray BellRemoved
test_np_deterministic
covered bytest_metric_results_accurate
. (GH#159) Aaron Spring
xskillscore v0.0.16 (2020-07-18)¶
Internal Changes¶
Add community support documents:
HOWTOCONTRIBUTE.rst
, issue template and pull request template. Aaron Spring and Ray BellReplace
pandas
withcftime
in examples and tests. Aaron Spring and Ray BellAdd coveralls for tests coverage. Aaron Spring and Ray Bell
Add
black
,flake8
,isort
,doc8
andpre-commit
for formatting similar toclimpred
. Aaron Spring and Ray Bell
Bug Fixes¶
Avoid mutating inputted arrays when skipna=True. (GH#111) Riley X. Brady.
Avoid read-only error that appeared due to not copying input arrays when dealing with NaNs. (GH#111) Riley X. Brady.
xskillscore v0.0.15 (2020-03-24)¶
Features¶
Update the
XSkillScoreAccessor
with all metrics. Ray Bell
xskillscore v0.0.14 (2020-03-20)¶
Features¶
Add
r2
as an implementation ofsklearn.metrics.r2_score
. Ray Bell
xskillscore v0.0.13 (2020-03-17)¶
Bug Fixes¶
Fixes https://github.com/raybellwaves/xskillscore/issues/79 assignment destination is read-only error when
skipna=True
and weights are passed. Andrew Huang
xskillscore v0.0.12 (2020-01-09)¶
Internal Changes¶
~30-50% speedup for deterministic metrics when
weights=None
. Aaron Spring
xskillscore v0.0.11 (2020-01-06)¶
Features¶
Add
effective_sample_size
,pearson_r_eff_p_value
, andspearman_r_eff_p_value
for computing statistical significance for temporally correlated data with autocorrelation. Riley X. Brady
xskillscore v0.0.10 (2019-12-21)¶
Deprecations¶
mad
no longer works and is replaced bymedian_absolute_error
. Riley X. Brady
Bug Fixes¶
skipna
forpearson_r
andspearman_r
and their p-values now reports accurate results when there are pairwise nans (i.e., nans that occur in different indices ina
andb
) Riley X. Brady
Testing¶
Test that results from grid cells in a gridded product match the same value if their time series were input directly into functions. Riley X. Brady
Test that metric results from
xskillscore
are the same value as an external package (e.g.numpy
,scipy
,sklearn
). Riley X. BradyTest that
skipna=True
works properly with pairwise nans. Riley X. Brady