Skip to content

[ENH] Type hints for primitives and string arguments:Part1#1472

Merged
TonyBagnall merged 6 commits intoaeon-toolkit:mainfrom
nileenagp:main
Apr 25, 2024
Merged

[ENH] Type hints for primitives and string arguments:Part1#1472
TonyBagnall merged 6 commits intoaeon-toolkit:mainfrom
nileenagp:main

Conversation

@nileenagp
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Fixes #1454

What does this implement/fix? Explain your changes.

Adding type hints to 2 methods in the script: aeon.classification.distance_based._time_series_neighbors.
Methods are : init(), get_test_params()

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

None

Any other comments?

Type hints are NOT added in other methods since they were not primitive types.

@aeon-actions-bot aeon-actions-bot bot added classification Classification package enhancement New feature, improvement request or other non-bug code enhancement labels Apr 24, 2024
@aeon-actions-bot
Copy link
Copy Markdown
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{#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.

@nileenagp
Copy link
Copy Markdown
Contributor Author

All the checks are passed successfully. Please review.

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 for the PR

@TonyBagnall TonyBagnall merged commit 23bd240 into aeon-toolkit:main Apr 25, 2024
Copy link
Copy Markdown
Member

@MatthewMiddlehurst MatthewMiddlehurst left a comment

Choose a reason for hiding this comment

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

The current ones here do not match the docstring currently as well I'm pretty sure.

n_jobs could be Optional[int] (defaults to None)
distance and weights could be Union[str, Callable] (accepts functions)

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

Labels

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

3 participants