release (#1474)

aeon-toolkit · Apr 25, 2024 · 317f2a6 · 317f2a6
1 parent 3b3b348
commit 317f2a6
Show file tree

Hide file tree

Showing 4 changed files with 207 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -13,11 +13,17 @@ We strive to provide a broad library of time series algorithms including the
 latest advances, offer efficient implementations using numba, and interfaces with other
 time series packages to provide a single framework for algorithm comparison.
 
-The latest `aeon` release is `v0.8.0`. You can view the full changelog
+The latest `aeon` release is `v0.8.1`. You can view the full changelog
 [here](https://www.aeon-toolkit.org/en/stable/changelog.html).
 
 Our webpage and documentation is available at https://aeon-toolkit.org.
 
+The following modules are still considered experimental, and the [deprecation policy](https://www.aeon-toolkit.org/en/stable/developer_guide/deprecation.html)
+does not apply:
+
+`annotation`, `anomaly_detection`, `benchmarking`, `segmentation`, `similarity_search`,
+`testing`, `transformations/series`, `visualisation`
+
 | Overview      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **CI/CD**     | [![github-actions-release](https://img.shields.io/github/actions/workflow/status/aeon-toolkit/aeon/release.yml?logo=github&label=build%20%28release%29)](https://github.com/aeon-toolkit/aeon/actions/workflows/release.yml) [![github-actions-main](https://img.shields.io/github/actions/workflow/status/aeon-toolkit/aeon/pr_pytest.yml?logo=github&branch=main&label=build%20%28main%29)](https://github.com/aeon-toolkit/aeon/actions/workflows/pr_pytest.yml) [![github-actions-nightly](https://img.shields.io/github/actions/workflow/status/aeon-toolkit/aeon/periodic_tests.yml?logo=github&label=build%20%28nightly%29)](https://github.com/aeon-toolkit/aeon/actions/workflows/periodic_tests.yml) [![docs-main](https://img.shields.io/readthedocs/aeon-toolkit/stable?logo=readthedocs&label=docs%20%28stable%29)](https://www.aeon-toolkit.org/en/stable/) [![docs-main](https://img.shields.io/readthedocs/aeon-toolkit/latest?logo=readthedocs&label=docs%20%28latest%29)](https://www.aeon-toolkit.org/en/latest/) [![!codecov](https://img.shields.io/codecov/c/github/aeon-toolkit/aeon?label=codecov&logo=codecov)](https://codecov.io/gh/aeon-toolkit/aeon) |

diff --git a/aeon/__init__.py b/aeon/__init__.py
@@ -1,6 +1,6 @@
 """aeon toolkit."""
 
-__version__ = "0.8.0"
+__version__ = "0.8.1"
 
 __all__ = ["show_versions"]
 

diff --git a/docs/changelogs/v0.8.md b/docs/changelogs/v0.8.md
@@ -1,3 +1,193 @@
+# v0.8.1
+
+April 2024
+
+The following modules are still considered experimental, and the deprecation policy does
+not apply:
+
+`annotation`, `anomaly_detection`, `benchmarking`, `segmentation`, `similarity_search`,
+`testing`, `transformations/series`, `visualisation`
+
+## Highlights
+
+- Mostly bug fixes, documentation improvements and new deprecations
+- Subgradient barycentre averaging is available for clustering ({user}`chrisholder`)
+
+## Anomaly Detection
+
+### Enhancements
+
+- [ENH] `BaseSeriesEstimator` rework ({pr}`1394`) {user}`MatthewMiddlehurst`
+
+## Classification
+
+### Documentation
+
+- [DOC] Correct `WeightedEnsembleClassifier` parameter docstring ({pr}`1418`) {user}`wayneadams`
+
+### Enhancements
+
+- [ENH] `fit_predict` for FreshPRINCE and RotationForest ({pr}`1456`) {user}`MatthewMiddlehurst`
+
+### Other
+
+- [BUG] Fix RDST doctest failure & numba deprecration warning ({pr}`1445`) {user}`baraline`
+
+## Clustering
+
+### Enhancements
+
+- [ENH] Subgradient barycentre averaging ({pr}`1339`) {user}`chrisholder`
+- [ENH] Kmeans allow empty clusters ({pr}`1400`) {user}`chrisholder`
+
+### Maintenance
+
+- [MNT] split up and simplified ba test ({pr}`1432`) {user}`chrisholder`
+
+## Datasets
+
+### Bug Fixes
+
+- [BUG] fix loader ({pr}`1428`) {user}`TonyBagnall`
+
+### Documentation
+
+- [DOC] PR #1452 ({pr}`1462`) {user}`RishavKumarSinha`
+
+## Distances
+
+### Enhancements
+
+- [ENH] Subgradient barycentre averaging ({pr}`1339`) {user}`chrisholder`
+- [ENH] Distance module pairwise unequal length support ({pr}`1356`) {user}`chrisholder`
+
+## Forecasting
+
+### Deprecation
+
+- [ENH] replace convert/convert_to with convert_series ({pr}`1338`) {user}`TonyBagnall`
+- [DEP] deprecate check_scorer ({pr}`1439`) {user}`TonyBagnall`
+- [DEP] deprecate probabilistic performance metric classes ({pr}`1436`) {user}`TonyBagnall`
+
+### Enhancements
+
+- [ENH] replace convert/convert_to with convert_series ({pr}`1338`) {user}`TonyBagnall`
+- [ENH] remove conversion in get_cutoff ({pr}`1342`) {user}`TonyBagnall`
+- [ENH] remove convert_to and vectorized import from index_functions ({pr}`1433`) {user}`TonyBagnall`
+
+### Other
+
+- [COV] Tests for testing/utils/data_gen ({pr}`1347`) {user}`TonyBagnall`
+
+## Regression
+
+### Enhancements
+
+- [ENH] `fit_predict` for FreshPRINCE and RotationForest ({pr}`1456`) {user}`MatthewMiddlehurst`
+
+## Segmentation
+
+### Enhancements
+
+- [ENH] `BaseSeriesEstimator` rework ({pr}`1394`) {user}`MatthewMiddlehurst`
+
+## Similarity Search
+
+### Enhancements
+
+- [ENH] `BaseSeriesEstimator` rework ({pr}`1394`) {user}`MatthewMiddlehurst`
+
+## Transformations
+
+### Bug Fixes
+
+- [BUG] Fix MultiRocketMultivariate failures ({pr}`1453`) {user}`baraline`
+
+### Deprecation
+
+- [DEP] deprecate check_scorer ({pr}`1439`) {user}`TonyBagnall`
+
+### Documentation
+
+- [DOC] PR #1452 ({pr}`1462`) {user}`RishavKumarSinha`
+
+### Enhancements
+
+- [ENH] BaseSeriesTransformer maintains axis for user determined output with BaseSeriesEstimator function ({pr}`1372`) {user}`TonyBagnall`
+- [ENH,REF] Refactor `univariate-only` tag ({pr}`1363`) {user}`itsdivya1309`
+- [ENH] `BaseSeriesEstimator` rework ({pr}`1394`) {user}`MatthewMiddlehurst`
+- [ENH] remove datatypes call from transformations test function ({pr}`1434`) {user}`TonyBagnall`
+- [ENH] Add support for array-like and statistical inputs as arguments in fill_value of Padding Transformer ({pr}`1373`) {user}`aadya940`
+- [ENH] Autocorrelation SeriesTransformer ({pr}`1380`) {user}`TonyBagnall`
+
+### Refactored
+
+- [ENH,REF] Refactor `univariate-only` tag ({pr}`1363`) {user}`itsdivya1309`
+
+### Other
+
+- [BUG] Fix RDST doctest failure & numba deprecration warning ({pr}`1445`) {user}`baraline`
+
+## Unit Testing
+
+### Maintenance
+
+- [MNT] Add Classifiers For Result Comparison ({pr}`1379`) {user}`harshithasudhakar`
+
+### Other
+
+- [COV] Tests for testing/utils/data_gen ({pr}`1347`) {user}`TonyBagnall`
+
+## Other
+
+### Bug Fixes
+
+- [BUG] allow np.ndarray with ndim>1 to convert to pd.series when squeezable to 1D ({pr}`1427`) {user}`TonyBagnall`
+
+### Deprecation
+
+- [DEP] Make `VectorizedDF` private ({pr}`1369`) {user}`MatthewMiddlehurst`
+
+### Documentation
+
+- [DOCS] Update the mentoring projects ({pr}`1366`) {user}`TonyBagnall`
+- [DOC] Fixes mis-wording/typo in mentoring docs ({pr}`1396`) {user}`wayneadams`
+- [DOC] Adds previously implemented classifiers to docs/api_references ({pr}`1401`) {user}`wayneadams`
+- [DOC] About Us webpage update ({pr}`1419`) {user}`MatthewMiddlehurst`
+- [DOC] Add estimator overview table with capabilities ({pr}`1426`) {user}`baraline`
+- [DOC] Remove optional from docstrings ({pr}`1458`) {user}`griegner`
+
+### Enhancements
+
+- [DEP] Deprecate _serialize file and load function ({pr}`1378`) {user}`TonyBagnall`
+- [ENH] remove datatypes call from test_interval_wrappers ({pr}`1435`) {user}`TonyBagnall`
+
+### Maintenance
+
+- [MNT] Notebook test exclusion tag and stale branch removal ({pr}`1316`) {user}`MatthewMiddlehurst`
+- [MNT] Update branch clean action ({pr}`1422`) {user}`MatthewMiddlehurst`
+- [MNT] `dask` CI fix, ReadTheDocs fix and expanded full pytest actions tag ({pr}`1420`) {user}`MatthewMiddlehurst`
+- [MNT] Update cache restore action ({pr}`1431`) {user}`aadya940`
+
+### Refactored
+
+- [REF] Move tag deprecation to registry ({pr}`1460`) {user}`MatthewMiddlehurst`
+
+## Contributors
+
+The following have contributed to this release through a collective 38 GitHub Pull Requests:
+
+{user}`aadya940`,
+{user}`baraline`,
+{user}`chrisholder`,
+{user}`griegner`,
+{user}`harshithasudhakar`,
+{user}`itsdivya1309`,
+{user}`MatthewMiddlehurst`,
+{user}`RishavKumarSinha`,
+{user}`TonyBagnall`,
+{user}`wayneadams`
+
 # v0.8.0
 
 April 2024

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aeon"
-version = "0.8.0"
+version = "0.8.1"
 description = "A toolkit for conducting machine learning tasks with time series data"
 authors = [
     {name = "aeon developers", email = "[email protected]"},
@@ -59,7 +59,6 @@ dependencies = [
 [project.optional-dependencies]
 all_extras = [
     "cloudpickle",
-    "dask[dataframe]<2024.3.0; python_version < '3.11'",
     "esig>=0.9.7,<0.9.8.3; python_version < '3.11'",
     "filterpy>=1.4.5",
     "gluonts>=0.12.4",
@@ -79,25 +78,27 @@ all_extras = [
     "stumpy>=1.5.1",
     "tbats>=1.1.0",
     "tensorflow>=2.12; python_version < '3.12' and python_version >= '3.9'",
-    "tensorflow-addons; python_version < '3.12'",
+    "tensorflow-addons; python_version < '3.12' and python_version >= '3.9'",
     "torch>=1.13.1",
     "tsfresh>=0.20.0",
     "tslearn>=0.5.2",
     "xarray",
 
     # for some reason, a heirarchical dask test fails on some Python versions with the
-    # later versions of pyarrow
+    # later versions of pyarrow and dask
+    "dask[dataframe]<2024.3.0; python_version < '3.11'",
     "pyarrow<12; python_version < '3.12'",
     "pyarrow-hotfix; python_version < '3.12'",
 ]
 dl = [
     "keras-self-attention",
     "tensorflow>=2.12; python_version < '3.12' and python_version >= '3.9'",
-    "tensorflow-addons; python_version < '3.12'",
+    "tensorflow-addons; python_version < '3.12' and python_version >= '3.9'",
 ]
 unstable_extras = [
-    "mrsqm>=0.0.1,<0.1.0 ; platform_system == 'Darwin'",  # requires gcc and fftw to be installed for Windows and some other OS (see http://www.fftw.org/index.html)
+    "mrsqm>=0.0.1,<0.1.0 ; platform_system == 'Darwin' and python_version < '3.12'",  # requires gcc and fftw to be installed for Windows and some other OS (see http://www.fftw.org/index.html)
     "pycatch22<=0.4.3",  # known to fail installation on some setups
+    "pyfftw>=0.12.0; python_version < '3.12'",  # requires fftw to be installed for Windows and some other OS (see http://www.fftw.org/index.html)
 ]
 dev = [
     "backoff",
@@ -107,7 +108,7 @@ dev = [
     "pytest-cov",
     "pytest-randomly",
     "pytest-timeout",
-    "pytest-xdist",
+    "pytest-xdist[psutil]",
     "pytest-rerunfailures",
     "wheel",
 ]
@@ -182,7 +183,7 @@ addopts = '''
     --durations 20
     --timeout 600
     --showlocals
-    --numprocesses auto
+    --numprocesses logical
     --dist worksteal
     --reruns 2
     --only-rerun "crashed while running"