Skip to content

[DOC] added type hints to 'classification->convolution_based' module#2494

Merged
TonyBagnall merged 2 commits intoaeon-toolkit:mainfrom
YashviMehta03:main
Jan 24, 2025
Merged

[DOC] added type hints to 'classification->convolution_based' module#2494
TonyBagnall merged 2 commits intoaeon-toolkit:mainfrom
YashviMehta03:main

Conversation

@YashviMehta03
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Fixes #1454

What does this implement/fix? Explain your changes.

All the .py files in the "/aeon/classification/convolution_based" module were missing type hints for primitive and string data types. I have added the necessary type hints for the module.

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

No

Any other comments?

No

PR checklist

For all contributions
  • I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
  • The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.
For new estimators and functions
  • I've added the estimator/function to the online API documentation.
  • (OPTIONAL) I've added myself as a __maintainer__ at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.
For developers with write access
  • (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

@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: [ $\color{#BCAE15}{\textsf{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, any trivial fixes will automatically be pushed to your PR unless it is a draft.

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

PR CI actions

These checkboxes will add labels to enable/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
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

Copy link
Copy Markdown
Contributor

@TonyBagnall TonyBagnall left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

@MatthewMiddlehurst MatthewMiddlehurst added the documentation Improvements or additions to documentation label Jan 14, 2025
@MatthewMiddlehurst MatthewMiddlehurst changed the title added type hints to 'classification->convolution_based' module [DOC] added type hints to 'classification->convolution_based' module Jan 14, 2025
@YashviMehta03
Copy link
Copy Markdown
Contributor Author

YashviMehta03 commented Jan 14, 2025

Hello @MatthewMiddlehurst , anything that needs to be changed for the PR to get merged ?

@TonyBagnall TonyBagnall merged commit 222d287 into aeon-toolkit:main Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

classification Classification package documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[ENH] Type hints for primitives and string arguments

3 participants