Skip to content

Rename SAX znormalized to znormalize, default to normalizing - #3756

Open
AmjadAAYD wants to merge 2 commits into
aeon-toolkit:mainfrom
AmjadAAYD:sax-znormalize-rename
Open

Rename SAX znormalized to znormalize, default to normalizing#3756
AmjadAAYD wants to merge 2 commits into
aeon-toolkit:mainfrom
AmjadAAYD:sax-znormalize-rename

Conversation

@AmjadAAYD

Copy link
Copy Markdown

Fixes #3678. znormalized=True meant input is already normalized (skip normalization), which is confusing since True reads as 'yes, normalize'. Added znormalize (default True, means 'do normalize') as the new parameter. znormalized is kept for backward compatibility with default sentinel 'deprecated', emits a FutureWarning when explicitly passed, and is internally mapped to the equivalent znormalize value (note the meaning is inverted: znormalized=True == znormalize=False).

Updated the one internal caller in _redcomets.py to use znormalize=False (behavior-preserving equivalent of its old znormalized=True call). Updated docstrings and the SAX.inverse_sax error message wording. Updated the existing test asserting the old default (test_sax_default_znormalized_is_true) to reflect the new default, and added a new test for the deprecation warning + value mapping.

Verified: full test_sax.py suite (48 tests) and both redcomets test files pass. Also ran a standalone check that get_params()/clone() still round-trip correctly for both the new and legacy parameter, per sklearn's estimator contract.

@aeon-actions-bot aeon-actions-bot Bot added classification Classification package transformations Transformations package labels Aug 22, 2026
@aeon-actions-bot

Copy link
Copy Markdown
Contributor

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.
I have added the following labels to this PR based on the changes made: [ classification, 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

@AmjadAAYD

Copy link
Copy Markdown
Author

Checked everything, all checks are passing.

@AmjadAAYD

Copy link
Copy Markdown
Author

Checked everything, all checks are passing now.

@patrickzib

Copy link
Copy Markdown
Contributor

Hmm, if I am not mistaken, we have two (three including this one) duplicate PRs for this now:

#3680
#3727

@MatthewMiddlehurst

MatthewMiddlehurst commented Aug 24, 2026

Copy link
Copy Markdown
Member

Yes this is a duplicate, and runs into the same issue as previous. See the review and functionality changes requested in #3680 if you wish to proceed please. This is more then a rename.

@TonyBagnall

Copy link
Copy Markdown
Contributor

perhaps we should change the issue to make it clearer its not just a name change?

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

Labels

classification Classification package 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