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

Improve visualization module documentation #2586

Closed
wants to merge 1 commit into from

Conversation

Kaustbh
Copy link

@Kaustbh Kaustbh commented Mar 3, 2025

Fixes: #2580

To address this issue, the following fixes are proposed:

  1. Adding New Notebooks:
    Introduce notebooks for the distances and estimator modules, providing examples and explanations for better usability.

  2. Fixing Duplication:

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 the examples Example notebook related label Mar 3, 2025
@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{#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

@Kaustbh
Copy link
Author

Kaustbh commented Mar 3, 2025

This is the initial commit for adding a notebook on distance matrix visualization. More updates and improvements will follow.

@Kaustbh Kaustbh closed this Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Example notebook related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Improve documentation for Aeon’s visualization module (aeon.visualisation)
1 participant