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

[DOC] Docstring added - TimeCNN Classifier #2624

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

KowshikB03
Copy link

@KowshikB03 KowshikB03 commented Mar 15, 2025

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
  • I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
  • 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.
For new estimators and functions
  • I've added the estimator/function to the online API documentation.
  • (OPTIONAL) I've added myself as a __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
  • (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.
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.

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 mypy typecheck tests
  • 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)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

@KowshikB03 KowshikB03 changed the title Docstring added - TimeCNN Classifier [DOC] Docstring added - TimeCNN Classifier Mar 15, 2025
Copy link
Member

@hadifawaz1999 hadifawaz1999 left a 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

@MatthewMiddlehurst
Copy link
Member

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.

@KowshikB03
Copy link
Author

@hadifawaz1999 I updated the PR now which only has the DocString changes.

@MatthewMiddlehurst I updated the PR template

@MatthewMiddlehurst
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
classification Classification package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants