Skip to content

Rename TDE/IndividualTDE parameter 'max_dims' to 'max_channels' (#3418)#3684

Closed
SpiliosDimakopoulos wants to merge 2 commits into
aeon-toolkit:mainfrom
SpiliosDimakopoulos:fix-tde-max-channels-3418
Closed

Rename TDE/IndividualTDE parameter 'max_dims' to 'max_channels' (#3418)#3684
SpiliosDimakopoulos wants to merge 2 commits into
aeon-toolkit:mainfrom
SpiliosDimakopoulos:fix-tde-max-channels-3418

Conversation

@SpiliosDimakopoulos

Copy link
Copy Markdown

No description provided.

…-toolkit#3418)

'max_dims' predates aeon settling on 'channels' terminology for
multivariate series dimensions, and is inconsistent with the rest of the
codebase (e.g. n_channels_, capability:multivariate).

This mirrors the identical rename already done for OrdinalTDE and
IndividualOrdinalTDE (which already expose 'max_channels' with a
deprecated 'max_dims' alias): adds 'max_channels' to
TemporalDictionaryEnsemble and IndividualTDE, keeps 'max_dims' for one
deprecation cycle with a FutureWarning mapping it to 'max_channels', and
updates the internal IndividualTDE construction inside
TemporalDictionaryEnsemble accordingly.

Also updates/extends aeon/classification/dictionary_based/tests/test_tde.py,
including a new test for the deprecation warning.

Fixes aeon-toolkit#3418
@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 ]. 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

The old 'znormalized' parameter defaulted to True, meaning 'do not
z-normalize because the input is already normalized' -- confusing,
since True implied normalization would happen.

This introduces 'znormalize' (default=True), which now always means
'z-normalize the windows'. The old 'znormalized' parameter is kept
for one deprecation cycle: passing it raises a FutureWarning and
maps to the equivalent 'znormalize' value (znormalize = not
znormalized), per the project's deprecation policy.

Also updates the SAX example notebook and REDCOMETS' internal SAX
call to the new parameter name, and updates/extends the SAX test
suite (including new tests for the deprecation warning and its
behavioural equivalence).

Fixes aeon-toolkit#3678
@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@TonyBagnall

Copy link
Copy Markdown
Contributor

thanks, but I assigned this and its also part of #3625

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

Labels

classification Classification package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants