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] add type hints to _shapelet_transform.py __init__ method #1926

Merged

Conversation

Datadote
Copy link
Contributor

@Datadote Datadote commented Aug 8, 2024

Reference Issues/PRs

What does this implement/fix? Explain your changes.

  • Add type hints to __init__ method in _shapelet_transform.py

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

  • New dependency added: "typing" library

Any other comments?

  1. Did not type parallel_backend because one types is "ParallelBackendBase", and did not know how to add that
  2. "contract_max_n_shapelet_samples" type -> Union[int, float] because np.inf (float type) is a default
  3. "time_limit_in_minutes" type -> Union[int, float] for flexibility. Documentation had int, but default value was 0.0 originally.

@aeon-actions-bot aeon-actions-bot bot added enhancement New feature, improvement request or other non-bug code enhancement transformations Transformations package labels Aug 8, 2024
@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{#41A8F6}{\textsf{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, 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 all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Push an empty commit to re-run CI checks

@Datadote Datadote force-pushed the typehint_shapelet_based branch from ad1dc90 to aee8d79 Compare August 9, 2024 23:18
@Datadote Datadote marked this pull request as ready for review August 9, 2024 23:55
@Datadote Datadote requested a review from aiwalter as a code owner August 9, 2024 23:55
@Datadote Datadote force-pushed the typehint_shapelet_based branch from aee8d79 to 1621fb2 Compare August 10, 2024 05:15
TonyBagnall
TonyBagnall previously approved these changes Aug 10, 2024
Copy link
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.

thanks, I just checked that time limit and contact num shapelets can in fact be ints and floats and its fine

@MatthewMiddlehurst
Copy link
Member

Not a blocker, fine with that as is, but is it better to do int or float or just float? I would say float implies integers are also accepted, but it is incredibly minor 🙂

@Datadote
Copy link
Contributor Author

Datadote commented Aug 12, 2024

I agree with Matthew's comment, and updated all "Union[int, float]" to "float".

Sorry to hadifawaz1999 and chrisholder, I wasn't trying to add you all as reviewers. My guess is updating my local branch with (git pull) the new aeon repo commits indirectly added them

@Datadote Datadote force-pushed the typehint_shapelet_based branch from df48f11 to ec2bde6 Compare August 12, 2024 23:08
@MatthewMiddlehurst MatthewMiddlehurst merged commit efa1546 into aeon-toolkit:main Aug 17, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature, improvement request or other non-bug code enhancement transformations Transformations package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants