aeon-toolkit / aeon

A toolkit for machine learning from time series
https://aeon-toolkit.org/
BSD 3-Clause "New" or "Revised" License
887 stars 94 forks source link

[DOC] - Find good images for examples docs [documentation] [good first issue] #1568 #1651

Closed Abhash297 closed 6 days ago

Abhash297 commented 3 weeks ago

Reference Issues/PRs

Gathered relevant images for the topics. Added a few references where it was necessary.

No new dependency

PR checklist

For all contributions
For new estimators and functions
For developers with write access
review-notebook-app[bot] commented 3 weeks ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

aeon-actions-bot[bot] commented 3 weeks ago

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.

TonyBagnall commented 3 weeks ago

@all-contributors add @Abhash297 for doc

Abhash297 commented 3 weeks ago

@TonyBagnall @MatthewMiddlehurst Please review the PR

TonyBagnall commented 3 weeks ago

so I appreciate the effort. Can you confirm that all these images are freely available not under copywrite?

Abhash297 commented 3 weeks ago

The images I took from research papers have been added to the reference section in the subsequent pages. Some Images like the one in "pre processing" were taken from an online article but it was a generic image so I did not add it to the reference.

MatthewMiddlehurst commented 2 weeks ago

IMO we should cut this back a bit, select a few examples/images and just focus on this in this PR. If the image is in examples/*/img, it should be used in the notebook itself.

MatthewMiddlehurst commented 2 weeks ago

examples/benchmarking/img/benchmark_algo1.png examples/classification/img/early.png examples/clustering/img/partition_tscl.png examples/datasets/img/example_ds.png examples/datasets/img/load_data.png examples/transformations/img/catch22.png examples/transformations/img/mini_rocket.png

These look fine, but some could use more informative names. Would select a couple from these for the first version of this PR (you can keep all of them in this one or a separate PR if you wish).