Skip to content

[DEP] Deprecate znormalized in favor of znormalize in SAX - #3727

Open
Dilraj07 wants to merge 1 commit into
aeon-toolkit:mainfrom
Dilraj07:mnt-sax-znormalize
Open

[DEP] Deprecate znormalized in favor of znormalize in SAX#3727
Dilraj07 wants to merge 1 commit into
aeon-toolkit:mainfrom
Dilraj07:mnt-sax-znormalize

Conversation

@Dilraj07

Copy link
Copy Markdown

Fixes #3678.

What does this implement/fix? Explain your changes.

Replaces the parameter znormalized in SAX with znormalize (default True), adds deprecation handling for znormalized, and updates unit tests.

Does your contribution introduce a new dependency? If yes, which one?

No.

PR checklist

  • The PR title starts with [MNT]

This pull request includes code written with the assistance of AI.
The code has been reviewed by a human.

@aeon-actions-bot aeon-actions-bot Bot added maintenance Continuous integration, unit testing & package distribution transformations Transformations package labels Aug 10, 2026
@aeon-actions-bot

Copy link
Copy Markdown
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ maintenance ].
I have added the following labels to this PR based on the changes made: [ transformations ]. Feel free to change these if they do not properly represent the PR.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, please run pre-commit locally and push the fixes to your PR branch.

Don't hesitate to ask questions on the aeon Discord channel if you have any.

PR CI actions

These checkboxes will add labels to enable or disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run mypy typecheck tests
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Disable numba cache loading
  • Regenerate expected results for testing
  • Push an empty commit to re-run CI checks

@TonyBagnall TonyBagnall left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the PR, but this will require deprecation I think, see our policy here
https://www.aeon-toolkit.org/en/latest/developer_guide/deprecation.html
its quite simple

@Dilraj07
Dilraj07 force-pushed the mnt-sax-znormalize branch from 3066c95 to 8066512 Compare August 15, 2026 17:35
@Dilraj07 Dilraj07 changed the title [MNT] Change parameter znormalized to znormalize in SAX transformation [DEP] Deprecate znormalized in favor of znormalize in SAX Aug 15, 2026
@Dilraj07

Copy link
Copy Markdown
Author

thanks for the PR, but this will require deprecation I think, see our policy here https://www.aeon-toolkit.org/en/latest/developer_guide/deprecation.html its quite simple

Thanks for the guidance! I have updated the PR to adhere to aeon's deprecation policy:

  • Set znormalized="deprecated" default in SAX.__init__ with the # TODO remove 'znormalized' in v1.7.0 removal comment.
  • Preserved backward compatibility by raising a FutureWarning (stacklevel=2) and mapping znormalized to znormalize.
  • Updated docstrings and added unit tests for the deprecation warning, default sentinel, and value mapping.
  • Updated the PR title prefix to [DEP].

@hadifawaz1999

Copy link
Copy Markdown
Member

We have duplicate PRs for this #3680

@MatthewMiddlehurst

MatthewMiddlehurst commented Aug 24, 2026

Copy link
Copy Markdown
Member

See the review and functionality changes requested in #3680 if you wish to proceed please. This is more then a rename.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Continuous integration, unit testing & package distribution transformations Transformations package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MNT] Change the parameter znormalized to znormalize in SAX transformation

4 participants