v0.5.0

September 2023

Following this release the deprecation policy remains suspended. Future releases may have breaking changes, so it may be wise to set an upper bound on the package version. It is likely a deprecation policy will be implemented and enforced starting v0.6.0, however.

Highlights

• New distance measures with ADTW and ShapeDTW (@chrisholder, @hadifawaz1999)

• Multiple new functions in the benchmarking module for creating figures i.e. Critical difference diagrams (@dguijo)

• New example notebooks and tidied versions of existing ones

• Lots of new bugfixes and testing to keep our estimators bug free (as much as possible at least)!

Annotation

Bug Fixes

• [Bugfix] Deprecation of tick.label in matplotlib >3.8.0 (#750) @patrickzib

Benchmarking

Documentation

• [DOC] Adding examples to the benchmarking functions docstrings. (#774) @dguijo

• [DOC] Adds notebook examples to benchmarking module (#771) @dguijo

Enhancements

• [ENH] Adds CD diagrams, violin plots, boxplots and some other graphs. (#582) @dguijo

Maintenance

• [ENH] Coverage for benchmarking (#719) @TonyBagnall

Classification

Bug Fixes

• [BUG] Fix EE test edge case (#738) @TonyBagnall

• [BUG] TDE and boxplot bugfixes (#786) @MatthewMiddlehurst

Documentation

• [DOC] Add example inception time classifier and regressor (#675) @hadifawaz1999

Enhancements

• [ENH] Revisions to classifier base class (#551) @TonyBagnall

• [ENH] New BaseCollectionEstimator class (#650) @TonyBagnall

• [ENH] reconfig HC tests (#735) @TonyBagnall

Maintenance

• [ENH] Improved ContinuousIntervalTree coverage (#720) @TonyBagnall

• [ENH] Improved coverage for classification (#727) @TonyBagnall

Clustering

Bug Fixes

• [BUG] add soft dep check to tslearn clusterers (#628) @TonyBagnall

• [BUG] Clustering notebook (and a few docstring typos) (#673) @TonyBagnall

• [BUG] Medoids empty cluster bug fix (#760) @chrisholder

Documentation

• [DOC] Update clustering notebook (#659) @TonyBagnall

Enhancements

• [ENH] New BaseCollectionEstimator class (#650) @TonyBagnall

Maintenance

• [MNT] reduce examples time for clusterers (#621) @TonyBagnall

• [MNT] Kmeans refactor (#762) @chrisholder

• [ENH] add clusterer base test (#768) @TonyBagnall

Datasets

Bug Fixes

• [BUG] typo in doctest skip (#634) @TonyBagnall

• [BUG] remove unnecessary call to os.path.dirname (#679) @TonyBagnall

• [BUG] fixes multivariate dataframe tsfile writes (#732) (#740) @hedeershowk

Maintenance

• [ENH] Improve coverage for datasets module (#665) @TonyBagnall

• [ENH] Improve coverage for datasets module (#733) @TonyBagnall

Distances

Bug Fixes

• [BUG] shapedtw using assert_almost_equal in test_distances (#767) @hadifawaz1999

• [BUG] Precision error on dist tests on mac (#791) @TonyBagnall

Documentation

• [DOC] Reformat distances docs (#646) @TonyBagnall

• [ENH] Docstrings for distances (#692) @TonyBagnall

• [DOC] Lets do the time warp again notebook (#743) @chrisholder

Enhancements

• [ENH] Itakura parallelogram bounding (#512) @chrisholder

• [ENH] ShapeDTW as a distance function ! (#754) @hadifawaz1999

• [ENH] Adtw distance (#759) @chrisholder

Forecasting

Documentation

• [DOC] Tidy and speed up forecasting example notebooks (#693) @MatthewMiddlehurst

Maintenance

• [MNT] Switch test configs on MATRIXDESIGN (#437) @TonyBagnall

• [ENH] Speed up forecasting tests (#701) @TonyBagnall

Networks

Bug Fixes

• [BUG] Fix bug in resnet network, strides (#690) @hadifawaz1999

Maintenance

• [ENH] Add a test for network module (#674) @hadifawaz1999

Regression

Documentation

• [DOC] Add example inception time classifier and regressor (#675) @hadifawaz1999

• [DOC] Regression notebook update (#686) @MatthewMiddlehurst

Enhancements

• [ENH] New BaseCollectionEstimator class (#650) @TonyBagnall

Transformations

Bug Fixes

• [BUG] Fixes a bug with numba’s typed dict in SFA when numba is disabled (#753) @patrickzib

• [BUG] Expected results rework and Shapelet Transform bugfix (#758) @MatthewMiddlehurst

Documentation

• [ENH] speed up signatures notebook (#662) @TonyBagnall

Enhancements

• [ENH] Change Dictionary transformers base class to BaseCollectionTransformer ( #638) @MatthewMiddlehurst

• [ENH] remove ColumnTransformer (#657) @TonyBagnall

• [ENH] Add normalisation transformer for time series (#612) @TonyBagnall

• [ENH] Change Rocket transformers base class to BaseCollectionTransformer (#637) @MatthewMiddlehurst

• [ENH] Change signature transform base class to BaseCollectionTransformer (#682) @MatthewMiddlehurst

• [ENH] Collection transformer compose.py cleanup (#683) @MatthewMiddlehurst

• [ENH] refactor shapelet transform (#718) @TonyBagnall

• [ENH] New BaseCollectionEstimator class (#650) @TonyBagnall

• [ENH] Efficiency slope transformer (#746) @steenrotsman

Maintenance

• [MNT] Collection transformation summarize refactor and removal (#643) @MatthewMiddlehurst

• [ENH] Test for efficiency slope transformer (#763) @steenrotsman

Refactored

• [MNT] Collection transformation summarize refactor and removal (#643) @MatthewMiddlehurst

Other

Bug Fixes

• [DOC] Update documentation for new devs and documentation build fixes (#739) @hedeershowk

Documentation

• [DOCS] pre-processing notebook and collections validations (#606) @TonyBagnall

• [DOC] Add Papers using Aeon section. (#611) @haskarb

• [MNT] Remove auto generated API page from toctree (#620) @MatthewMiddlehurst

• [DOC] Configure website cards to scale images (#631) @MatthewMiddlehurst

• [ENH] some minor edits of notebook text (#635) @TonyBagnall

• [DOC] Add @dguijo to core developer table and CODEOWNERS (#678) @MatthewMiddlehurst

• [DOC] Developer and conda install instructions (#680) @MatthewMiddlehurst

• [DOC] Fix README test badge (#687) @MatthewMiddlehurst

• [DOC] README conda badge (#688) @MatthewMiddlehurst

• [DOC] Remove related software page (#681) @MatthewMiddlehurst

• [DOC] Glossary rewrite (#694) @MatthewMiddlehurst

• [DOC] Update slack links (#729) @MatthewMiddlehurst

• [DOC] Update documentation for new devs and documentation build fixes (#739) @hedeershowk

• [DOC][Sweep] Update papers_using_aeon.md with new publication for time series clustering (#737) @sweep-ai[bot]

• added plot visualizing the Italy power data (#745) @kgmuzungu

• [DOC] Update API page in docs/api_reference/distances.rst (#776) @sweep-ai[bot]

• [DOC] add papers to papers using aeon page (#780) @TonyBagnall

• [DOC] A couple of typos (#775) @TonyBagnall

• [DOC] Tidy up referencing in doc strings (#781) @TonyBagnall

• [DOC] Various small documentation fixes (#792) @MatthewMiddlehurst

Enhancements

• [ENH] centralise and tidy up the converters (#576) @TonyBagnall

• [ENH] Remove all directory from packages (#642) @MatthewMiddlehurst

• [ENH] Testing revision version 1 (#597) @TonyBagnall

• [ENH] Remove top of file warnings for soft dependencies (#641) @MatthewMiddlehurst

• [ENH] Improve coverage of base directory (#716) @TonyBagnall

Maintenance

• [MNT] Remove auto generated API page from toctree (#620) @MatthewMiddlehurst

• [MNT] Add runtime list for notebook test (#619) @MatthewMiddlehurst

• [MNT] Skip code coverage test failures (#624) @MatthewMiddlehurst

• [ENH] Speed up test all estimators (#595) @TonyBagnall

• [ENH] remove interval based fails (#629) @TonyBagnall

• [MNT] Skip tests for PRs which do not touch any important or aeon/ files (#636) @MatthewMiddlehurst

• [MNT] Remove InceptionTime estimators from test exclusion (#640) @MatthewMiddlehurst

• [ENH] Speed up inception time tests (#689) @TonyBagnall

• [ENH] Speed up resnet tests (#691) @TonyBagnall

• [MNT] Rename --matrixdesign and update documentation (#639) @MatthewMiddlehurst

• [MNT] Update contributors file (#684) @MatthewMiddlehurst

• [MNT] fixed precommit stack level warnings (#706) @chrisholder

• [MNT] Sweep issue template (#731) @MatthewMiddlehurst

• [MNT] Update Sweep config (#764) @MatthewMiddlehurst

• [MNT] Add pre-commit bot which pushes fixes to PRs (#770) @MatthewMiddlehurst

• [MNT] Uncomment pytest config (#783) @MatthewMiddlehurst

Refactored

• [MNT] Remove calls to aeon.datatypes (#710) @TonyBagnall

Other

• [ENH] remove exclusions from testing in tests/_config.py (#661) @TonyBagnall

• [BUG] Update _show_versions.py (aeon-toolkit#670) (#671) @sylvaincom

• [MNT] remove exclusions (#696) @TonyBagnall

• Configure Sweep (#736) @sweep-ai[bot]

• [ENH] Update sweep.yaml to improve Sweep Sandbox (#777) @kevinlu1248

Contributors

The following have contributed to this release through a collective 97 GitHub Pull Requests:

@chrisholder, @dguijo, @hadifawaz1999, @haskarb, @hedeershowk, @kevinlu1248, @kgmuzungu, @MatthewMiddlehurst, @patrickzib, @steenrotsman, @sylvaincom, @TonyBagnall