Skip to content

[DOC] LITE Time classifier metrics #2464

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

Merged

Conversation

dschrempf
Copy link
Contributor

State that Keras Metrics class objects (and functions) can be used. Also link to the Keras documentation.

Closes #2435

Any other comments?

Maybe this change is also relevant for other Keras-based (tensorflow-based) estimators?

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.

State that Keras Metrics class objects (and functions) can be used. Also link to
the Keras documentation.
@aeon-actions-bot aeon-actions-bot bot added classification Classification package documentation Improvements or additions to documentation labels Dec 18, 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{#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

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.

LGTM thanks ! So all of our deep learning models should have this change in DOCs, so am happy to get this in now so we can create an issue for it and link this PR as a base example of what should be done, could you create such issue and close the one you made for LITE ?

@hadifawaz1999 hadifawaz1999 merged commit c8efd14 into aeon-toolkit:main Dec 18, 2024
17 checks passed
@dschrempf
Copy link
Contributor Author

I just realized, there was a small typo: if -> If. I can create an issue for the other Keras-based classifiers.

Also, pyright (and I guess also mypy) do not understand that one can use keras.metrics.Metric objects, since metric is initialized to "accuray" which is a str. However, I didn't want to add a type hint because it seems they are not used much in aeon.

@dschrempf dschrempf deleted the lite-metrics-docs-no-nix branch December 19, 2024 13:10
@MatthewMiddlehurst
Copy link
Member

@dschrempf feel free to open an issue. We want to incorporate type hints but theres a lot to go through so they are not required for now. Always welcome though and we can help if they include optional dependencies i.e, tensorflow

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Type of "metrics" of deep learning classifiers using keras could be improved
3 participants