-
Notifications
You must be signed in to change notification settings - Fork 197
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
[DOC] Docstring added - TimeCNN Classifier #2624
base: main
Are you sure you want to change the base?
Conversation
Thank you for contributing to
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again as we mentioned before, we do not want any change in the activation usage of TimeCNN, just a mention that sigmoid is used and not softmax, so again i ask you that the PR should only include a sentence in the docstring and no change in the TimeCNNClassifier code
Please fill out the template and explain your changes. The note is a bit lax, it should include why this is relevant and how someone can change it. |
@hadifawaz1999 I updated the PR now which only has the DocString changes. @MatthewMiddlehurst I updated the PR template |
Please add the extra detail as requested and ensure the tests do not fail. You do not need to bold any of it IMO. Make sure you look at the API page generated by readthedocs to make sure it renders correctly. |
What does this implement/fix?
Fixes issue #2593
A docstring has been added explicitly stating that the TimeCNN model uses Sigmoid activation and MSE as the loss function to clarify its design and prevent further attempts of optimization
Does your contribution introduce a new dependency? If yes, which one?
No
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