Skip to content

Release v1.1.0 #2696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ 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 `v1.0.0`. You can view the full changelog
The latest `aeon` release is `v1.1.0`. 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.
Expand Down
2 changes: 1 addition & 1 deletion aeon/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""aeon toolkit."""

__version__ = "1.0.0"
__version__ = "1.1.0"
1 change: 1 addition & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ To stay up to date with aeon releases, subscribe to aeon
[here](https://libraries.io/pypi/aeon) or follow us on
[Twitter](https://twitter.com/aeon_toolbox).

- [Version 1.1.0](changelogs/v1.1.md)
- [Version 1.0.0](changelogs/v1.0.md)
- [Version 0.11.1](changelogs/v0/v0.11.md)
- [Version 0.11.0](changelogs/v0/v0.11.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/changelogs/v1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ has helped make this release possible.
This major release includes breaking changes that could not happen in a regular
minor release. This includes the removal of the old forecasting wrapper-based code,
the datatypes module and the previous transformer module. Our focus now is on
writing more efficient code based on efficient array based bespoke implementations.
writing efficient code based on array-based bespoke implementations.

## Highlights

Expand Down
294 changes: 294 additions & 0 deletions docs/changelogs/v1.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
# v1.1.0

April 2025

## Highlights

- Python 3.13 is now supported and dependency bounds have been raised
- `df-list` collections now require (`n_cases`, `n_channels`, `n_timepoints`) formatting.
Make sure each dataframe in the list has channels as the first dimension and timepoints are the second.
- The ROCKAD anomaly detector has been added ({user}`pattplatt`)
- THe KASBA clusterer has been added ({user}`chrisholder`)
- Lots of documentation improvements and bug fixes

## Anomaly Detection

### Documentation

- [DOC] Anomaly Detection Overview Notebook ({pr}`2446`) {user}`itsdivya1309`

### Enhancements

- [ENH] Added ROCKAD anomaly detector to aeon ({pr}`2376`) {user}`pattplatt`
- [ENH] Replace `prts` metrics ({pr}`2400`) {user}`aryanpola`

## Benchmarking

### Deprecation

- [MNT,DEP] _binary.py metrics deprecated ({pr}`2600`) {user}`aryanpola`

### Documentation

- Fix docstring inconsistencies in benchmarking module (resolves #809) ({pr}`2735`) {user}`adityagh006`

### Enhancements

- [ENH] Replace `prts` metrics ({pr}`2400`) {user}`aryanpola`
- [ENH] Remove MutilROCKETRegressor from alias mapping ({pr}`2623`) {user}`Kaustbh`
- [ENH] Hard-Coded Tests for `test_metrics.py` ({pr}`2672`) {user}`aryanpola`

### Maintenance

- [MNT,DEP] _binary.py metrics deprecated ({pr}`2600`) {user}`aryanpola`

## Classification

### Bug Fixes

- [BUG] Passed stride parameter to LITETimeClassifier ({pr}`2502`) {user}`kavya-r30`
- [BUG] LITE Network : Fixed list arguments ({pr}`2510`) {user}`kavya-r30`

### Documentation

- [DOC] Add LITETimeClassifier Example to Classification Notebook ({pr}`2419`) {user}`sumana-2705`
- [DOC] Inserting the right paper reference ({pr}`2440`) {user}`adilsonmedronha`
- [DOC] LITE Time classifier metrics ({pr}`2464`) {user}`dschrempf`
- [DOC] Updated docstring to clarify class_weight parameter in MRHydraClassifier ({pr}`2505`) {user}`Akhil-Jasson`
- [DOC] added type hints to 'classification->convolution_based' module ({pr}`2494`) {user}`YashviMehta03`
- [DOC] Documentation improvement of BaseDeepClassifier and BaseCollectionEstimator ({pr}`2516`) {user}`kevinzb56`
- [DOC] Add 'Raises' section to docstring (#1766) ({pr}`2484`) {user}`Nikitas100`

### Enhancements

- [ENH] Added possibility for pooling strides in TimeCNN ({pr}`2485`) {user}`kavya-r30`
- [ENH] Replace SFA with SFAFast in REDCOMETS ({pr}`2418`) {user}`itsdivya1309`
- [ENH] Added class weights to feature based classifiers ({pr}`2512`) {user}`lucifer4073`
- [ENH] Set `outlier_norm` default to True for Catch22 estimators ({pr}`2659`) {user}`tanishy7777`

### Maintenance

- [MNT] Fixed wrong type annotations for aeon classes ({pr}`2488`) {user}`shinymack`
- [MNT] Raise version bound for `scikit-learn` 1.6 ({pr}`2486`) {user}`MatthewMiddlehurst`
- [MNT] Remove REDCOMETs from testing exclusion list ({pr}`2630`) {user}`MatthewMiddlehurst`

## Clustering

### Documentation

- [DOC] Update Partitional clustering notebook ({pr}`2483`) {user}`Akhil-Jasson`
- [DOC] Notebook on Feature-based Clustering ({pr}`2579`) {user}`itsdivya1309`

### Enhancements

- [ENH] KASBA clusterer ({pr}`2428`) {user}`chrisholder`
- [ENH] Removed Reshape Layer from Deep Learning Clusterers ({pr}`2495`) {user}`kavya-r30`
- [ENH] Adds kdtw kernel support for kernelkmeans ({pr}`2645`) {user}`tanishy7777`
- [ENH] Add dummy clusterer tags ({pr}`2551`) {user}`MatthewMiddlehurst`

### Maintenance

- [MNT] Fix random state deep clustering checking test ({pr}`2528`) {user}`hadifawaz1999`
- [MNT] Raise version bound for `scikit-learn` 1.6 ({pr}`2486`) {user}`MatthewMiddlehurst`

## Datasets

### Enhancements

- [ENH] Collection conversion cleanup and `df-list` fix ({pr}`2654`) {user}`MatthewMiddlehurst`

## Distances

### Bug Fixes

- [BUG, ENH] SFA fix: Std-Normalization, as used in BOSS and WEASEL models, is potentially harmful for lower bounding ({pr}`2461`) {user}`patrickzib`

### Documentation

- [DOC] ddtw_distance Documentation Fix ({pr}`2443`) {user}`notaryanramani`
- [DOC] Distance function notebook #2395 ({pr}`2487`) {user}`kevinzb56`

### Enhancements

- [BUG, ENH] SFA fix: Std-Normalization, as used in BOSS and WEASEL models, is potentially harmful for lower bounding ({pr}`2461`) {user}`patrickzib`
- [ENH] Adds support for distances that are asymmetric but supports unequal length ({pr}`2613`) {user}`tanishy7777`
- [ENH] Support for unequal length in itakura parallelogram ({pr}`2647`) {user}`tanishy7777`
- [ENH] Implement DTW with Global alignment ({pr}`2565`) {user}`tanishy7777`

## Forecasting

### Documentation

- [DOC] Added Docstring for regression forecasting ({pr}`2564`) {user}`kavya-r30`

### Enhancements

- [ENh] Forecasting tests ({pr}`2427`) {user}`TonyBagnall`

## Networks

### Bug Fixes

- [BUG] LITE Network : Fixed list arguments ({pr}`2510`) {user}`kavya-r30`

### Enhancements

- [ENH] Added possibility for pooling strides in TimeCNN ({pr}`2485`) {user}`kavya-r30`
- [ENH] Add and Validate `n_layers`, `n_units`, `activation` & `dropout_rate` kwargs to MLPNetwork ({pr}`2338`) {user}`aadya940`
- [ENH] Test coverage for AEResNetNetwork Improved ({pr}`2518`) {user}`lucifer4073`
- [ENH] Test coverage for MLP Network improved ({pr}`2537`) {user}`shinymack`
- [ENH] Test coverage for FCNNetwork Improved ({pr}`2559`) {user}`lucifer4073`
- [ENH] Test coverage for AEFCNNetwork Improved ({pr}`2558`) {user}`lucifer4073`
- [ENH] Test coverage for TimeCNNNetwork Improved ({pr}`2534`) {user}`lucifer4073`
- [ENH] Test coverage for Resnet Network ({pr}`2553`) {user}`kavya-r30`

## Regression

### Bug Fixes

- [BUG] LITE Network : Fixed list arguments ({pr}`2510`) {user}`kavya-r30`

### Documentation

- [DOC] Base collection class docstring formatting ({pr}`2452`) {user}`TonyBagnall`
- [DOC] Inconsistent double qoutes in regression module ({pr}`2640`) {user}`Val-2608`

### Maintenance

- [MNT] Fixed wrong type annotations for aeon classes ({pr}`2488`) {user}`shinymack`
- [MNT] Raise version bound for `scikit-learn` 1.6 ({pr}`2486`) {user}`MatthewMiddlehurst`

## Segmentation

### Enhancements

- [ENH] Remove test exclusions ({pr}`2409`) {user}`TonyBagnall`

## Transformations

### Bug Fixes

- [BUG] add ExpSmoothingSeriesTransformer and MovingAverageSeriesTransformer to __init__ ({pr}`2550`) {user}`Cyril-Meyer`
- [BUG] SevenNumberSummary bugfix and input rename ({pr}`2555`) {user}`MatthewMiddlehurst`

### Documentation

- [DOC] Base collection class docstring formatting ({pr}`2452`) {user}`TonyBagnall`
- [DOC] Create smoothing filters notebook ({pr}`2547`) {user}`Cyril-Meyer`
- [DOC] Clarify documentation regarding unequal length series limitation ({pr}`2589`) {user}`Kaustbh`

### Enhancements

- [ENH] Refactor BinSegSegmenter to BinSegmenter ({pr}`2408`) {user}`TonyBagnall`
- [ENH] Remove test exclusions ({pr}`2409`) {user}`TonyBagnall`

## Unit Testing

### Enhancements

- [ENH] Remove test exclusions ({pr}`2409`) {user}`TonyBagnall`
- [ENh] Forecasting tests ({pr}`2427`) {user}`TonyBagnall`
- [ENH] adjust test for non numpy output ({pr}`2517`) {user}`TonyBagnall`
- [ENH] Collection conversion cleanup and `df-list` fix ({pr}`2654`) {user}`MatthewMiddlehurst`
- [MNT,ENH] Update to allow Python 3.13 ({pr}`2608`) {user}`MatthewMiddlehurst`

### Maintenance

- [MNT] Testing fixes ({pr}`2531`) {user}`MatthewMiddlehurst`
- [MNT] Fix random state deep clustering checking test ({pr}`2528`) {user}`hadifawaz1999`
- [MNT] Skip some excected results tests when numba is disabled ({pr}`2639`) {user}`MatthewMiddlehurst`
- [MNT] Remove REDCOMETs from testing exclusion list ({pr}`2630`) {user}`MatthewMiddlehurst`
- [MNT,ENH] Update to allow Python 3.13 ({pr}`2608`) {user}`MatthewMiddlehurst`

## Visualisations

### Documentation

- [DOC] Added Missing Docstring for Plot Pairwise Distance Matrix ({pr}`2609`) {user}`kavya-r30`

### Enhancements

- [ENH] Test Coverage for Pairwise Distance ({pr}`2590`) {user}`kavya-r30`
- [ENH] `best_on_top` addition in `plot_pairwise_scatter` ({pr}`2655`) {user}`aryanpola`

## Other

### Documentation

- [DOC] Contributing guide and template changes ({pr}`2423`) {user}`MatthewMiddlehurst`
- [DOC] Created a adding_typehints.md in developers_guide that Fixes issue #1857 ({pr}`2424`) {user}`vedpawar2254`
- [DOC] Add comment to readme.md ({pr}`2450`) {user}`TonyBagnall`
- [DOC] Contributing readme and other contributing updates ({pr}`2445`) {user}`MatthewMiddlehurst`
- [DOC] add note to install pandoc ({pr}`2489`) {user}`inclinedadarsh`
- [DOC] Added search functionality for estimator overview table ({pr}`2496`) {user}`kavya-r30`
- [DOC] Fixed</li> tags appearance on the end on list in partition clustering notebook ({pr}`2504`) {user}`kavya-r30`
- [DOC] Update custom CSS for dataframe styling in documentation ({pr}`2508`) {user}`inclinedadarsh`
- [DOC] Improve type hint guide and add link to the page. ({pr}`2532`) {user}`MatthewMiddlehurst`
- [DOC] Fixed Output Error in Interval Based Notebook ({pr}`2620`) {user}`kavya-r30`
- [DOC] Add GSoC announcement to web page ({pr}`2629`) {user}`MatthewMiddlehurst`
- [DOC] Update dependencies.md ({pr}`2717`) {user}`TinaJin0228`
- [DOC] re-running notebook for fixing error in cell output ({pr}`2597`) {user}`Kaustbh`
- [DOC] Add 'Raises' section to docstring #1766 ({pr}`2617`) {user}`ayushsingh9720`
- [DOC] Contributor docs update ({pr}`2554`) {user}`MatthewMiddlehurst`
- [DOC] Add link to about us page and fix badge link in README ({pr}`2556`) {user}`MatthewMiddlehurst`
- [DOC] Fixed a few spelling/grammar mistakes on TSC docs examples ({pr}`2738`) {user}`HaroonAzamFiza`

### Enhancements

- [ENH] Add sphinx event to add capability table to estimators' docs individually ({pr}`2468`) {user}`inclinedadarsh`
- [DOC] Added search functionality for estimator overview table ({pr}`2496`) {user}`kavya-r30`
- [ENH,MNT] Assign Bot (assigned issues>2) ({pr}`2702`) {user}`aryanpola`
- [MNT,ENH] Assign-bot (Allow users to type alternative phrases for assingment) ({pr}`2704`) {user}`Ramana-Raja`

### Maintenance

- [MNT] Trying to diagnose ubuntu workflow failures ({pr}`2413`) {user}`MatthewMiddlehurst`
- [MNT] Set upper bound on esig version ({pr}`2463`) {user}`chrisholder`
- [MNT] Swapped tensorflow and pytorch to install only CPU version ({pr}`2416`) {user}`chrisholder`
- [MNT] Temporary exclusion of REDCOMETS from CI ({pr}`2522`) {user}`MatthewMiddlehurst`
- [MNT] Use MacOS for examples/ workflow ({pr}`2668`) {user}`shinymack`
- [MNT] issue-assign-bot (prevent assignment on PRs) ({pr}`2703`) {user}`shinymack`
- [MNT] Fix run_examples.sh exclusion ({pr}`2701`) {user}`MatthewMiddlehurst`
- [MNT] Updated the release workflows ({pr}`2638`) {user}`MatthewMiddlehurst`
- [ENH,MNT] Assign Bot (assigned issues>2) ({pr}`2702`) {user}`aryanpola`
- [MNT,ENH] Assign-bot (Allow users to type alternative phrases for assingment) ({pr}`2704`) {user}`Ramana-Raja`

### Other

- [GOV] Infrastructure workgroup lead and voting ambiguity fix ({pr}`2426`) {user}`MatthewMiddlehurst`

## Contributors

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

{user}`aadya940`,
{user}`adilsonmedronha`,
{user}`adityagh006`,
{user}`Akhil-Jasson`,
{user}`aryanpola`,
{user}`ayushsingh9720`,
{user}`chrisholder`,
{user}`Cyril-Meyer`,
{user}`dschrempf`,
{user}`hadifawaz1999`,
{user}`HaroonAzamFiza`,
{user}`inclinedadarsh`,
{user}`itsdivya1309`,
{user}`Kaustbh`,
{user}`kavya-r30`,
{user}`kevinzb56`,
{user}`lucifer4073`,
{user}`MatthewMiddlehurst`,
{user}`Nikitas100`,
{user}`notaryanramani`,
{user}`patrickzib`,
{user}`pattplatt`,
{user}`Ramana-Raja`,
{user}`shinymack`,
{user}`sumana-2705`,
{user}`tanishy7777`,
{user}`TinaJin0228`,
{user}`TonyBagnall`,
{user}`Val-2608`,
{user}`vedpawar2254`,
{user}`YashviMehta03`
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,6 @@ def find_source():
# documentation.

html_theme_options = {
"announcement": "<em>Announcement</em>: aeon is taking part in the Google Summer of Code (GSoC) 2025! See the home page for more information.", # noqa: E501
"sidebar_hide_name": True,
"top_of_page_button": "edit",
"source_repository": "https://github.com/aeon-toolkit/aeon/",
Expand Down
9 changes: 0 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,6 @@ segmentation and similarity search.
- We provide a range of tools for reproducing benchmarking results and evaluating time
series algorithms implemented in `aeon` and other `scikit-learn` compatible packages.

```{admonition} GSoC 2025
`aeon` is participating in Google Summer of Code 2025 under the NumFOCUS umbrella. If
you are interested in participating, please see our [GSoC 2025 project page](https://github.com/aeon-toolkit/aeon-admin/blob/main/gsoc/gsoc-2025-projects.md).
Feel free to ask questions on the dedicated [GitHub discussion](https://github.com/aeon-toolkit/aeon/discussions/2530)
or our [Slack channel](https://join.slack.com/t/aeon-toolkit/shared_invite/zt-22vwvut29-HDpCu~7VBUozyfL_8j3dLA).
If you are interested in contributing, click on the "Contributing to aeon" link in the
sidebar for a contribution guide. Applications close April 8th.
```

## Community Channels

**GitHub**: [github.com/aeon-toolkit/aeon](https://github.com/aeon-toolkit/aeon)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "aeon"
version = "1.0.0"
version = "1.1.0"
description = "A toolkit for machine learning from time series"
authors = [
{name = "aeon developers", email = "[email protected]"},
Expand Down