Skip to content
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

[ENH] Adding type hinting for files: aeon/benchmarking/* #2667

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

gulshan-123
Copy link

Reference Issues/PRs

Fixes #1454 some part

What does this implement/fix? Explain your changes.

I have added type hinting in the files. For this I also needed to import from typing such as List, Union etc.
I have added hints just in the parameter of some functions in the python files.

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

No

Any other comments?

I will work on some other folders if this PR gets done. I am new to Open Source. This is my first contribution and I loved it. Thanks.

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.

@aeon-actions-bot aeon-actions-bot bot added benchmarking Benchmarking package enhancement New feature, improvement request or other non-bug code enhancement labels Mar 20, 2025
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#FEF1BE}{\textsf{enhancement}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#264F59}{\textsf{benchmarking}}$ ]. 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

@gulshan-123 gulshan-123 force-pushed the benchmarking-type-hinting branch from f005d02 to 1e26a5e Compare March 21, 2025 02:19
@gulshan-123 gulshan-123 force-pushed the benchmarking-type-hinting branch from 52ee90d to a0ab705 Compare March 21, 2025 02:26
@gulshan-123
Copy link
Author

@baraline @MatthewMiddlehurst @hadifawaz1999 @TonyBagnall Could you please review this PR? I have addressed all the necessary changes. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
benchmarking Benchmarking package enhancement New feature, improvement request or other non-bug code enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENH] Type hints for primitives and string arguments
1 participant