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] Improve documentation for Aeon’s visualization module (aeon.visualisation) #2580

Open
Kaustbh opened this issue Mar 2, 2025 · 1 comment · May be fixed by #2602
Open

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

Kaustbh opened this issue Mar 2, 2025 · 1 comment · May be fixed by #2602
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Kaustbh
Copy link

Kaustbh commented Mar 2, 2025

Describe the issue linked to the documentation

Currently, the Aeon visualization module lacks comprehensive documentation for several implemented plotting functions. While there are three existing notebooks:
https://www.aeon-toolkit.org/en/latest/examples.html#visualisation

  1. "Plotting Time Series"
  2. "Plotting Results"
  3. "Plotting for Learning-Specific Tasks"

Additionally notebooks for "Plotting time series" and "Plotting for learning specific tasks" appear to be the same.

Suggest a potential alternative/fix

  1. Adding new notebooks for the distances and estimator modules.

  2. Fixing the duplication in the existing notebooks.

@Kaustbh Kaustbh added the documentation Improvements or additions to documentation label Mar 2, 2025
@Kaustbh
Copy link
Author

Kaustbh commented Mar 2, 2025

@aeon-actions-bot assign @Kaustbh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
1 participant