[ENH] adding type hints for files in aeon/classification/deep_learning#3241
[ENH] adding type hints for files in aeon/classification/deep_learning#3241MatthewMiddlehurst merged 14 commits intoaeon-toolkit:mainfrom
Conversation
Thank you for contributing to
|
MatthewMiddlehurst
left a comment
There was a problem hiding this comment.
Please use the requested title format in the future.
Typically a default of None will be mapped to something else as we want default parameters to be immutable.
"update to the latest repo"
aeon-toolkit#3241) * "adding type hints for files in aeon/classification/deep_learning" * Automatic `pre-commit` fixes * "revise an error in cnn.py and remove importing Union" * "revise the last file name and the init file name" * "removing the dependence on List and Tuple" * "revise the docstrings" * "another revise the docstring" * "trim trailing whitespace" * "revise the wording in the docs"
Reference Issues/PRs
Fixes #1454 some part
What does this implement/fix? Explain your changes.
Adding type hints to files in
aeon/classification/deep_learningDoes your contribution introduce a new dependency? If yes, which one?
None
Any other comments?
Just a little question... I notice that in the documentation of the deep learning models, the parameter like
n_filtersis said to be default to a list of integers. However, in thedef init, these parameters are always defaulted toNone. Is that intentional?Don't worry, I didn't change anything about the default values of any parameters; I only added the type hints. I'm just curious about the design of the code :)
PR checklist
For all contributions
For new estimators and functions
__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