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] Add details of deep learning classifiers in the deep learning notebook #2447

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

Conversation

Sachin-G13
Copy link

Reference Issues/PRs

Fixes #2384

What does this implement/fix? Explain your changes.

Adds and describes the other deep learning classifiers that we have in the deep learning notebook.

The added classifiers include:

  • BaseDeepClassifier
  • TimeCNNClassifier
  • FCNClassifier
  • DisjointClassifier
  • LITETimeClassifier
  • IndividualLITETimeClassifier
  • HInception
  • EncoderClassifier

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

None

Any other comments?

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.
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.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@aeon-actions-bot aeon-actions-bot bot added documentation Improvements or additions to documentation examples Example notebook related labels Dec 12, 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{#F3B9F8}{\textsf{documentation}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#45FD64}{\textsf{examples}}$ ]. 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

@itsdivya1309 itsdivya1309 added the classification Classification package label Dec 19, 2024
@baraline
Copy link
Member

baraline commented Jan 16, 2025

Hi @Sachin-G13 thanks for the PR, I think you can make the following adjustments :

  • The description of the deep learning base class does not bring much here, I think you could mention that all deep learning classifiers inherit it at the beginning of the notebook, but the current description doesn't feel right to me

  • Describing the other deep learning classifiers and adding images is good, but try to organize them with sections in a logical order. For example, presenting Inception and then Lite, currently there is many things in between and I think it hurts the reading experience.

@MatthewMiddlehurst
Copy link
Member

Is this still being worked on @Sachin-G13 ?

@Sachin-G13
Copy link
Author

Yeah, I am working on it 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
classification Classification package documentation Improvements or additions to documentation examples Example notebook related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Details of deep learning classifiers in notebook
4 participants