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 hinting to _shapelet_transform __init__ #1917

Closed
wants to merge 0 commits into from

Conversation

Datadote
Copy link
Contributor

@Datadote Datadote commented Aug 6, 2024

Reference Issues/PRs

Part of #1910 and references #1454

What does this implement/fix? Explain your changes.

Added type hints to __init__ method inside of _shapelet_transform.py

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

New dependency added: "typing" library

Any other comments?

  1. For parameters with optional values, which format is preferred for aeon?
    A) Optional[int]
    B) Union[None, int]
    I think option A is the generally preferred, but I saw option B in other aeon code.
    E.g. aeon/similarity_search/query_search.py
  2. "contract_max_n_shapelete" parameter uses int, but has np.inf as a default.
    Np.inf is a float. Is it ok to modify that parameter to be "int or float"?
    E.g. contract_max_n_shapelet_samples: Union[int, float] = np.inf

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.
  • 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 enhancement New feature, improvement request or other non-bug code enhancement transformations Transformations package labels Aug 6, 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

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.

LGTM, thanks

@TonyBagnall
Copy link
Contributor

ah sorry, still a WIP

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.

2 participants